mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Automated commit by github action: 15116461494
This commit is contained in:
GitHub Action Bot
@@ -1,5 +1,5 @@
|
||||
get:
|
||||
summary: "List Access Model Metadata Attributes"
|
||||
summary: "List access model metadata attributes"
|
||||
description: "Get a list of Access Model Metadata Attributes"
|
||||
tags:
|
||||
- Access Model Metadata
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
get:
|
||||
summary: "List Access Model Metadata Values"
|
||||
summary: "List access model metadata values"
|
||||
description: "Get a list of Access Model Metadata Attribute Values"
|
||||
tags:
|
||||
- Access Model Metadata
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
get:
|
||||
summary: "Get Access Model Metadata Value"
|
||||
summary: "Get access model metadata value"
|
||||
description: "Get single Access Model Metadata Attribute Value"
|
||||
tags:
|
||||
- Access Model Metadata
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
get:
|
||||
summary: "Get Access Model Metadata Attribute"
|
||||
summary: "Get access model metadata attribute"
|
||||
description: "Get single Access Model Metadata Attribute"
|
||||
tags:
|
||||
- Access Model Metadata
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: deleteAccessProfilesInBulk
|
||||
summary: Delete Access Profile(s)
|
||||
summary: Delete access profile(s)
|
||||
tags:
|
||||
- Access Profiles
|
||||
description: >-
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: updateAccessProfilesInBulk
|
||||
summary: Update Access Profile(s) requestable field.
|
||||
summary: Update access profile(s) requestable field.
|
||||
tags:
|
||||
- Access Profiles
|
||||
description: >-
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAccessProfileEntitlements
|
||||
tags:
|
||||
- Access Profiles
|
||||
summary: List Access Profile's Entitlements
|
||||
summary: List access profile's entitlements
|
||||
description: >-
|
||||
Use this API to get a list of an access profile's entitlements.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAccessProfile
|
||||
tags:
|
||||
- Access Profiles
|
||||
summary: Get an Access Profile
|
||||
summary: Get an access profile
|
||||
description: >-
|
||||
This API returns an Access Profile by its ID.
|
||||
parameters:
|
||||
@@ -45,7 +45,7 @@ patch:
|
||||
operationId: patchAccessProfile
|
||||
tags:
|
||||
- Access Profiles
|
||||
summary: Patch a specified Access Profile
|
||||
summary: Patch a specified access profile
|
||||
description: >-
|
||||
This API updates an existing Access Profile. The following fields are patchable:
|
||||
|
||||
@@ -135,7 +135,7 @@ delete:
|
||||
operationId: deleteAccessProfile
|
||||
tags:
|
||||
- Access Profiles
|
||||
summary: Delete the specified Access Profile
|
||||
summary: Delete the specified access profile
|
||||
description: >-
|
||||
This API deletes an existing Access Profile.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listAccessProfiles
|
||||
tags:
|
||||
- Access Profiles
|
||||
summary: List Access Profiles
|
||||
summary: List access profiles
|
||||
description: >-
|
||||
Get a list of access profiles.
|
||||
|
||||
@@ -124,7 +124,7 @@ post:
|
||||
operationId: createAccessProfile
|
||||
tags:
|
||||
- Access Profiles
|
||||
summary: Create Access Profile
|
||||
summary: Create access profile
|
||||
description: >-
|
||||
Create an access profile.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAccessRequestApprovalSummary
|
||||
security:
|
||||
- userAuth: [ idn:access-request-approvals-summary:read ]
|
||||
summary: Get Access Requests Approvals Number
|
||||
summary: Get access requests approvals number
|
||||
tags:
|
||||
- Access Request Approvals
|
||||
description: >-
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: accessRolesChangeSegmentAssignments
|
||||
tags:
|
||||
- Segments
|
||||
summary: Change Segment assignments.
|
||||
summary: Change segment assignments.
|
||||
description: >-
|
||||
This API allows to change the Segment assignments for roles and access-profiles.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listAccountActivities
|
||||
tags:
|
||||
- Account Activities
|
||||
summary: List Account Activities
|
||||
summary: List account activities
|
||||
description: >-
|
||||
This gets a collection of account activities that satisfy the given query parameters.
|
||||
parameters:
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAccountActivity
|
||||
tags:
|
||||
- Account Activities
|
||||
summary: Get Account Activity
|
||||
summary: Get account activity
|
||||
description: >-
|
||||
This gets a single account activity by its id.
|
||||
parameters:
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAccountAggregationStatus
|
||||
tags:
|
||||
- Account Aggregations
|
||||
summary: In-progress Account Aggregation status
|
||||
summary: In-progress account aggregation status
|
||||
description: >-
|
||||
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
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAccount
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Account Details
|
||||
summary: Account details
|
||||
description: >-
|
||||
Use this API to return the details for a single account by its ID.
|
||||
|
||||
@@ -49,7 +49,7 @@ patch:
|
||||
operationId: updateAccount
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Update Account
|
||||
summary: Update account
|
||||
description: |
|
||||
Use this API to update account details.
|
||||
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
@@ -140,7 +140,7 @@ put:
|
||||
operationId: putAccount
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Update Account
|
||||
summary: Update account
|
||||
description: |
|
||||
Use this API to update an account with a PUT request.
|
||||
|
||||
@@ -196,7 +196,7 @@ delete:
|
||||
operationId: deleteAccount
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Delete Account
|
||||
summary: Delete account
|
||||
description: >-
|
||||
Use this API to delete an account.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: disableAccount
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Disable Account
|
||||
summary: Disable account
|
||||
description: >-
|
||||
This API submits a task to disable the account and returns the task ID.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: enableAccount
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Enable Account
|
||||
summary: Enable account
|
||||
description: >-
|
||||
This API submits a task to enable account and returns the task ID.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAccountEntitlements
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Account Entitlements
|
||||
summary: Account entitlements
|
||||
description: >-
|
||||
This API returns entitlements of the account.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: submitReloadAccount
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Reload Account
|
||||
summary: Reload account
|
||||
description: >-
|
||||
This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: unlockAccount
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Unlock Account
|
||||
summary: Unlock account
|
||||
description: >-
|
||||
This API submits a task to unlock an account and returns the task ID.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listAccounts
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Accounts List
|
||||
summary: Accounts list
|
||||
description: >-
|
||||
List accounts.
|
||||
deprecated: true
|
||||
@@ -175,7 +175,7 @@ post:
|
||||
operationId: createAccount
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Create Account
|
||||
summary: Create account
|
||||
description: |
|
||||
Submits an account creation task - the API then returns the task ID.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ post:
|
||||
- userAuth: [ iai:access-request-recommender:manage ]
|
||||
x-sailpoint-userLevels:
|
||||
- Any
|
||||
summary: Ignore Access Request Recommendation
|
||||
summary: Ignore access request recommendation
|
||||
description: >-
|
||||
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.
|
||||
@@ -43,7 +43,7 @@ get:
|
||||
- userAuth: [ iai:access-request-recommender:manage ]
|
||||
x-sailpoint-userLevels:
|
||||
- Any
|
||||
summary: List Ignored Access Request Recommendations
|
||||
summary: List ignored access request recommendations
|
||||
description: >-
|
||||
This API returns the list of ignored access request recommendations.
|
||||
parameters:
|
||||
|
||||
@@ -6,7 +6,7 @@ post:
|
||||
- userAuth: [ iai:access-request-recommender:manage ]
|
||||
x-sailpoint-userLevels:
|
||||
- Any
|
||||
summary: Accept Access Request Recommendation
|
||||
summary: Accept access request recommendation
|
||||
description: >-
|
||||
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.
|
||||
@@ -43,7 +43,7 @@ get:
|
||||
- userAuth: [ iai:access-request-recommender:manage ]
|
||||
x-sailpoint-userLevels:
|
||||
- Any
|
||||
summary: List Accepted Access Request Recommendations
|
||||
summary: List accepted access request recommendations
|
||||
description: >-
|
||||
This API returns a list of requested access request recommendations.
|
||||
parameters:
|
||||
|
||||
@@ -6,7 +6,7 @@ post:
|
||||
- userAuth: [ iai:access-request-recommender:manage ]
|
||||
x-sailpoint-userLevels:
|
||||
- Any
|
||||
summary: Bulk Mark Viewed Access Request Recommendations
|
||||
summary: Bulk mark viewed access request recommendations
|
||||
description: >-
|
||||
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
|
||||
|
||||
@@ -6,7 +6,7 @@ post:
|
||||
- userAuth: [ iai:access-request-recommender:manage ]
|
||||
x-sailpoint-userLevels:
|
||||
- Any
|
||||
summary: Mark Viewed Access Request Recommendations
|
||||
summary: Mark viewed access request recommendations
|
||||
description: >-
|
||||
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
|
||||
@@ -43,7 +43,7 @@ get:
|
||||
- userAuth: [ iai:access-request-recommender:read ]
|
||||
x-sailpoint-userLevels:
|
||||
- Any
|
||||
summary: List Viewed Access Request Recommendations
|
||||
summary: List viewed access request recommendations
|
||||
description: >-
|
||||
This API returns the list of viewed access request recommendations.
|
||||
parameters:
|
||||
|
||||
@@ -6,7 +6,7 @@ get:
|
||||
- userAuth: [ iai:access-request-recommender:read ]
|
||||
x-sailpoint-userLevels:
|
||||
- Any
|
||||
summary: Identity Access Request Recommendations
|
||||
summary: Identity access request recommendations
|
||||
description: >-
|
||||
This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.
|
||||
parameters:
|
||||
|
||||
@@ -4,7 +4,7 @@ get:
|
||||
operationId: getApproval
|
||||
tags:
|
||||
- Approvals
|
||||
summary: Get Approval
|
||||
summary: Get approval
|
||||
description: >-
|
||||
Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals.
|
||||
parameters:
|
||||
|
||||
@@ -4,7 +4,7 @@ get:
|
||||
operationId: getApprovals
|
||||
tags:
|
||||
- Approvals
|
||||
summary: Get Approvals
|
||||
summary: Get approvals
|
||||
description: >-
|
||||
Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: approveAccessRequest
|
||||
summary: Approve Access Request Approval
|
||||
summary: Approve access request approval
|
||||
tags:
|
||||
- Access Request Approvals
|
||||
description: >-
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: assignVerifiedFromAddresses
|
||||
tags:
|
||||
- Notifications
|
||||
summary: Assign Verified From Address
|
||||
summary: Assign verified from address
|
||||
description: >-
|
||||
Assign pre-existing verified, From email address to current tenant.
|
||||
requestBody:
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getSourceAttrSyncConfig
|
||||
tags:
|
||||
- Sources
|
||||
summary: Attribute Sync Config
|
||||
summary: Attribute sync config
|
||||
description: >-
|
||||
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.
|
||||
@@ -44,7 +44,7 @@ put:
|
||||
operationId: putSourceAttrSyncConfig
|
||||
tags:
|
||||
- Sources
|
||||
summary: Update Attribute Sync Config
|
||||
summary: Update attribute sync config
|
||||
description: >-
|
||||
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"
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
operationId: getTenantAttrSyncConfig
|
||||
tags:
|
||||
- Attribute Synchronization
|
||||
summary: Tenant Attribute Sync Config
|
||||
summary: Tenant attribute sync config
|
||||
description: >-
|
||||
This API returns the attribute synchronization configuration for a tenant. The response contains
|
||||
configuration data for individual identity attributes and the corresponding target sources that
|
||||
@@ -34,7 +34,7 @@ post:
|
||||
operationId: createTenantAttrSyncConfig
|
||||
tags:
|
||||
- Attribute Synchronization
|
||||
summary: New Tenant Attribute Sync Config
|
||||
summary: New tenant attribute sync config
|
||||
description: >-
|
||||
This API creates a new attribute synchronization configuration for a tenant. The payload contains
|
||||
configuration data for individual identity attributes and the corresponding target sources that
|
||||
@@ -71,7 +71,7 @@ put:
|
||||
operationId: replaceTenantAttrSyncConfig
|
||||
tags:
|
||||
- Attribute Synchronization
|
||||
summary: Update Tenant Attribute Sync Config
|
||||
summary: Update tenant attribute sync config
|
||||
description: >-
|
||||
This API replaces an existing attribute synchronization configuration for a tenant. Only the
|
||||
"attributes" property is mutable. The "attributes" property contains the synchronization configuration
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAuthOrgConfig
|
||||
tags:
|
||||
- Auth Org Configuration
|
||||
summary: Get Auth Org Configuration
|
||||
summary: Get auth org configuration
|
||||
description: >-
|
||||
This gets the details of an org's auth configuration.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAuthOrgServiceProviderConfig
|
||||
tags:
|
||||
- Auth Org Configuration
|
||||
summary: Get Service Provider Configuration.
|
||||
summary: Get service provider configuration.
|
||||
description: >-
|
||||
This API returns the details of an org's service provider auth
|
||||
configuration. Requires security scope of: 'sp:auth-org:read'
|
||||
@@ -31,7 +31,7 @@ patch:
|
||||
operationId: patchAuthOrgServiceProviderConfig
|
||||
tags:
|
||||
- Auth Org Configuration
|
||||
summary: Update Service Provider Configuration
|
||||
summary: Update service provider configuration
|
||||
description: >-
|
||||
This API updates an existing service provider configuration for an org using
|
||||
PATCH. Requires security scope of: 'sp:auth-org:update'
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getProfileConfig
|
||||
tags:
|
||||
- Auth Profile
|
||||
summary: Get Auth Profile.
|
||||
summary: Get auth profile.
|
||||
description: >-
|
||||
This API returns auth profile information.
|
||||
parameters:
|
||||
@@ -39,7 +39,7 @@ patch:
|
||||
operationId: patchProfileConfig
|
||||
tags:
|
||||
- Auth Profile
|
||||
summary: Patch a specified Auth Profile
|
||||
summary: Patch a specified auth profile
|
||||
description: >-
|
||||
This API updates an existing Auth Profile. The following fields are patchable:
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getProfileConfigList
|
||||
tags:
|
||||
- Auth Profile
|
||||
summary: Get list of Auth Profiles.
|
||||
summary: Get list of auth profiles.
|
||||
description: >-
|
||||
This API returns a list of auth profiles.
|
||||
security:
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: updateAuthUserPassword
|
||||
tags:
|
||||
- Auth User
|
||||
summary: Auth User Password Update
|
||||
summary: Auth user password update
|
||||
description: Update a password of existing user in the authentication system by overwriting the password with new password.
|
||||
# security:
|
||||
# - oauth2: [sp:auth-user-password:update]
|
||||
|
||||
@@ -2,7 +2,7 @@ put:
|
||||
operationId: setAuthUser
|
||||
tags:
|
||||
- Auth User
|
||||
summary: Auth User Update - Overwrite
|
||||
summary: Auth user update - overwrite
|
||||
description: Update an existing user in the authentication system by over overwriting the information with new information.
|
||||
security:
|
||||
- userAuth: [sp:auth-user-internal:update]
|
||||
@@ -48,7 +48,7 @@ delete:
|
||||
operationId: deleteAuthUser
|
||||
tags:
|
||||
- Auth User
|
||||
summary: Delete an Auth User
|
||||
summary: Delete an auth user
|
||||
description: Delete an existing user in the authentication system.
|
||||
security:
|
||||
- userAuth: [sp:auth-user:delete]
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: forgot-username
|
||||
tags:
|
||||
- Forgot Username
|
||||
summary: Retrieve Forgotten Username
|
||||
summary: Retrieve forgotten username
|
||||
description: This API sends an email to allow a user to retrieve a forgotten username when a valid email address associated with a valid account is provided.
|
||||
requestBody:
|
||||
required: true
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: authMfaConfirmRegistration
|
||||
tags:
|
||||
- Auth MFA
|
||||
summary: Confirm a user's registration for MFA
|
||||
summary: Confirm a user's registration for mfa
|
||||
description: >-
|
||||
For a user who is not currently registered for MFA and who has just scanned
|
||||
the QR code containing the TOTP URL provided by the /generate-secret
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: authMfaGenerateMfaToken
|
||||
tags:
|
||||
- Auth MFA
|
||||
summary: Generate a special token for calling sp-mfa /totp/** APIs
|
||||
summary: Generate a special token for calling sp-mfa /totp/** apis
|
||||
description: >-
|
||||
Generates an MFA token and establishes an unverified MFA-on-login context state.
|
||||
Callable by either an internal service or an authenticated user.
|
||||
|
||||
@@ -3,7 +3,7 @@ post:
|
||||
tags:
|
||||
- Auth MFA
|
||||
summary:
|
||||
Generate a TOTP secret embedded within a TOTP link for use with an
|
||||
Generate a totp secret embedded within a totp link for use with an
|
||||
authenticator
|
||||
description: >-
|
||||
For a user who is not currently registered for MFA, generates a secret to
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: authMfaRegistrationReset
|
||||
tags:
|
||||
- Auth MFA
|
||||
summary: Disable a user's registration for MFA
|
||||
summary: Disable a user's registration for mfa
|
||||
description: >-
|
||||
Disables a user's registration for MFA. The specified user is tied to the `requestedFor` body param and can either be an external id,
|
||||
when resetting the registration on someone else's behalf, or "me", when resetting the registration for one's self.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: authMfaRegistrationStatus
|
||||
tags:
|
||||
- Auth MFA
|
||||
summary: Determine whether the user is registered for MFA
|
||||
summary: Determine whether the user is registered for mfa
|
||||
description: >-
|
||||
Gives the caller an indication of whether or not the user associated with the `externalId` path param is registered for MFA.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: authMfaVerifyCode
|
||||
tags:
|
||||
- Auth MFA
|
||||
summary: Validate a TOTP code generated by a user's authenticator
|
||||
summary: Validate a totp code generated by a user's authenticator
|
||||
description: >-
|
||||
For a user who is registered for MFA, validates a TOTP code generated by the
|
||||
user's authenticator.
|
||||
|
||||
@@ -4,7 +4,7 @@ get:
|
||||
# - oauth2: [idn:authorization-model:read]
|
||||
tags:
|
||||
- Authorization Model
|
||||
summary: List Authorization Model Capabilities
|
||||
summary: List authorization model capabilities
|
||||
description: >-
|
||||
This API returns the list of capabilities from the Authorization Model Service.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ post:
|
||||
- userAuth: [ idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: Tag Multiple Objects
|
||||
summary: Tag multiple objects
|
||||
description: >-
|
||||
This API adds tags to multiple objects.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ post:
|
||||
- userAuth: [ idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: Remove Tags from Multiple Objects
|
||||
summary: Remove tags from multiple objects
|
||||
description: >-
|
||||
This API removes tags from multiple objects.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: bulkUpdateAuthUser
|
||||
tags:
|
||||
- Auth User
|
||||
summary: Auth User Bulk Update
|
||||
summary: Auth user bulk update
|
||||
description: Update up to 100 existing auth users in a batch.
|
||||
# security:
|
||||
# - oauth2: [sp:auth-user:update]
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: startCampaign
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Activate a Campaign
|
||||
summary: Activate a campaign
|
||||
description: |
|
||||
Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign).
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ post:
|
||||
operationId: move
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Reassign Certifications
|
||||
summary: Reassign certifications
|
||||
description: |
|
||||
This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move).
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: completeCampaign
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Complete a Campaign
|
||||
summary: Complete a campaign
|
||||
description: |
|
||||
:::caution
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCampaignReportsConfig
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Get Campaign Reports Configuration
|
||||
summary: Get campaign reports configuration
|
||||
deprecated: true
|
||||
description: |
|
||||
Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config).
|
||||
@@ -32,7 +32,7 @@ put:
|
||||
operationId: setCampaignReportsConfig
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Set Campaign Reports Configuration
|
||||
summary: Set campaign reports configuration
|
||||
deprecated: true
|
||||
description: |
|
||||
Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config).
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCampaignReports
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Get Campaign Reports
|
||||
summary: Get campaign reports
|
||||
deprecated: true
|
||||
description: |
|
||||
Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports).
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: startCampaignRemediationScan
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Run Campaign Remediation Scan
|
||||
summary: Run campaign remediation scan
|
||||
description: |
|
||||
Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan).
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: startCampaignReport
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Run Campaign Report
|
||||
summary: Run campaign report
|
||||
deprecated: true
|
||||
description: |
|
||||
Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report).
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: startGenerateCampaignTemplate
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Generate a Campaign from Template
|
||||
summary: Generate a campaign from template
|
||||
deprecated: true
|
||||
security:
|
||||
- userAuth: [idn:campaign-template:manage]
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCampaignTemplateSchedule
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Get Campaign Template Schedule
|
||||
summary: Get campaign template schedule
|
||||
description: |
|
||||
Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule).
|
||||
|
||||
@@ -44,7 +44,7 @@ put:
|
||||
operationId: setCampaignTemplateSchedule
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Set Campaign Template Schedule
|
||||
summary: Set campaign template schedule
|
||||
description: |
|
||||
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.
|
||||
Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule).
|
||||
@@ -153,7 +153,7 @@ delete:
|
||||
operationId: deleteCampaignTemplateSchedule
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Delete Campaign Template Schedule
|
||||
summary: Delete campaign template schedule
|
||||
description: |
|
||||
Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule).
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCampaignTemplate
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Get a Campaign Template
|
||||
summary: Get a campaign template
|
||||
description: |
|
||||
Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template).
|
||||
|
||||
@@ -51,7 +51,7 @@ patch:
|
||||
operationId: patchCampaignTemplate
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Update a Campaign Template
|
||||
summary: Update a campaign template
|
||||
description: |
|
||||
Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template).
|
||||
|
||||
@@ -124,7 +124,7 @@ delete:
|
||||
operationId: deleteCampaignTemplate
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Delete a Campaign Template
|
||||
summary: Delete a campaign template
|
||||
description: |
|
||||
Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template).
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCampaignTemplates
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: List Campaign Templates
|
||||
summary: List campaign templates
|
||||
description: |
|
||||
Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates).
|
||||
|
||||
@@ -69,7 +69,7 @@ post:
|
||||
operationId: createCampaignTemplate
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Create a Campaign Template
|
||||
summary: Create a campaign template
|
||||
description: |
|
||||
Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template).
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCampaign
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Get Campaign
|
||||
summary: Get campaign
|
||||
description: |
|
||||
Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign).
|
||||
|
||||
@@ -51,7 +51,7 @@ patch:
|
||||
operationId: updateCampaign
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Update a Campaign
|
||||
summary: Update a campaign
|
||||
description: |
|
||||
Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign).
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: deleteCampaigns
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Delete Campaigns
|
||||
summary: Delete campaigns
|
||||
description: |
|
||||
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns).
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getActiveCampaigns
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: List Campaigns
|
||||
summary: List campaigns
|
||||
description: |
|
||||
Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns).
|
||||
|
||||
@@ -91,7 +91,7 @@ post:
|
||||
operationId: createCampaign
|
||||
tags:
|
||||
- Certification Campaigns
|
||||
summary: Create Campaign
|
||||
summary: Create campaign
|
||||
description: |
|
||||
Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign).
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
tags:
|
||||
- Certifications
|
||||
- Certification Campaigns
|
||||
summary: Certification Task by ID
|
||||
summary: Certification task by id
|
||||
deprecated: true
|
||||
description: >-
|
||||
This API returns the certification task for the specified ID. A token with ORG_ADMIN or CERT_ADMIN authority is
|
||||
|
||||
@@ -3,7 +3,7 @@ get:
|
||||
tags:
|
||||
- Certifications
|
||||
- Certification Campaigns
|
||||
summary: List of Pending Certification Tasks
|
||||
summary: List of pending certification tasks
|
||||
deprecated: true
|
||||
description: >-
|
||||
This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCertification
|
||||
tags:
|
||||
- Certifications
|
||||
summary: Certification by ID
|
||||
summary: Certification by id
|
||||
description: >-
|
||||
This API returns a single certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to
|
||||
call this API. Reviewers for this certification can also call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getAccessSummaries
|
||||
tags:
|
||||
- Certification Summaries
|
||||
summary: Access Summaries
|
||||
summary: Access summaries
|
||||
description: >-
|
||||
This API returns a list of access summaries for the specified certification and type. A token with ORG_ADMIN or
|
||||
CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: makeDecision
|
||||
tags:
|
||||
- Certifications
|
||||
summary: Decide on a Certification Item
|
||||
summary: Decide on a certification item
|
||||
description: >-
|
||||
The API makes a decision to approve or revoke a certification item. A token with ORG_ADMIN or CERT_ADMIN authority
|
||||
is required to call this API. Reviewers for this certification can also call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getDecisionSummary
|
||||
tags:
|
||||
- Certification Summaries
|
||||
summary: Summary of Certification Decisions
|
||||
summary: Summary of certification decisions
|
||||
description: >-
|
||||
This API returns a summary of the decisions made on an certification. A token with ORG_ADMIN or CERT_ADMIN authority
|
||||
is required to call this API. Reviewers for this certification can also call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCertificationEntitlementPermissions
|
||||
tags:
|
||||
- Certifications
|
||||
summary: Permissions for Entitlement in a Certification
|
||||
summary: Permissions for entitlement in a certification
|
||||
description: >-
|
||||
This API returns the permissions associated with an entitlement that is part of a certification campaign. The
|
||||
entitlement provided must match the entitlement from an entitlement certification item, or be part of an access
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: reassignCertsAsync
|
||||
tags:
|
||||
- Certifications
|
||||
summary: Reassign Certifications Asynchronously
|
||||
summary: Reassign certifications asynchronously
|
||||
description: >-
|
||||
This API initiates a task to reassign up to 500 identities or items in a 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
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: reassignCertifications
|
||||
tags:
|
||||
- Certifications
|
||||
summary: Reassign Identities or Items
|
||||
summary: Reassign identities or items
|
||||
description: >-
|
||||
This API reassigns up to 50 identities or items in a 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.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listReviewItemsActivityData
|
||||
tags:
|
||||
- Certifications
|
||||
summary: List of Review Items Activity Data
|
||||
summary: List of review items activity data
|
||||
description: >-
|
||||
This API returns activity data for a list of review items for an identity campaign certification. The activity data applies to the results of the previous call to review-items API. A token with ORG_ADMIN or
|
||||
CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listReviewItems
|
||||
tags:
|
||||
- Certifications
|
||||
summary: List of Review Items
|
||||
summary: List of review items
|
||||
description: >-
|
||||
This API returns a list of review items for and identity campaign certification. A token with ORG_ADMIN or
|
||||
CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listCertificationReviewers
|
||||
tags:
|
||||
- Certifications
|
||||
summary: List of Reviewers for certification
|
||||
summary: List of reviewers for certification
|
||||
description: >-
|
||||
This API returns a list of reviewers for the certification. A token with ORG_ADMIN or
|
||||
CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: signOffCertification
|
||||
tags:
|
||||
- Certifications
|
||||
summary: Finalize Certification Decisions
|
||||
summary: Finalize certification decisions
|
||||
description: >-
|
||||
This API finalizes all decisions made on an certification and initiates any remediations required. A token with
|
||||
ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getTargetSummaries
|
||||
tags:
|
||||
- Certification Summaries
|
||||
summary: Target Summaries for a Certification
|
||||
summary: Target summaries for a certification
|
||||
description: >-
|
||||
This API returns a list of the target summaries for a specific certification. A token with ORG_ADMIN or CERT_ADMIN
|
||||
authority is required to call this API. Reviewers for this certification can also call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getTargetSummary
|
||||
tags:
|
||||
- Certification Summaries
|
||||
summary: Summary for a Certification Target
|
||||
summary: Summary for a certification target
|
||||
description: >-
|
||||
This API returns the summary for a target on a specified certification. A token with ORG_ADMIN or CERT_ADMIN
|
||||
authority is required to call this API. Reviewers for this certification can also call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listCertifications
|
||||
tags:
|
||||
- Certifications
|
||||
summary: Certifications by IDs
|
||||
summary: Certifications by ids
|
||||
description: >-
|
||||
This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call
|
||||
this API, but only certifications you are authorized to review will be returned.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
get:
|
||||
operationId: listCompletedApprovals
|
||||
summary: Completed Access Request Approvals List
|
||||
summary: Completed access request approvals list
|
||||
tags:
|
||||
- Access Request Approvals
|
||||
description: >-
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
operationId: validateConnectorRule
|
||||
summary: Validate Connector Rule
|
||||
summary: Validate connector rule
|
||||
description: >-
|
||||
Returns a list of issues within the code to fix, if any.
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
get:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
summary: Connector-Rule by ID
|
||||
summary: Connector-rule by id
|
||||
operationId: getConnectorRule
|
||||
description: >-
|
||||
Returns the connector rule specified by ID.
|
||||
@@ -44,7 +44,7 @@ get:
|
||||
put:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
summary: Update a Connector Rule
|
||||
summary: Update a connector rule
|
||||
description: >-
|
||||
Updates an existing connector rule with the one provided in the request body.
|
||||
Note that the fields 'id', 'name', and 'type' are immutable.
|
||||
@@ -95,7 +95,7 @@ put:
|
||||
delete:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
summary: Delete a Connector-Rule
|
||||
summary: Delete a connector-rule
|
||||
description: >-
|
||||
Deletes the connector rule specified by the given ID.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
operationId: getConnectorRuleList
|
||||
summary: List Connector Rules
|
||||
summary: List connector rules
|
||||
description: >-
|
||||
Returns the list of connector rules.
|
||||
|
||||
@@ -33,7 +33,7 @@ post:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
operationId: createConnectorRule
|
||||
summary: Create Connector Rule
|
||||
summary: Create connector rule
|
||||
description: >-
|
||||
Creates a new connector rule.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
tags:
|
||||
- Connectors
|
||||
operationId: getConnectorList
|
||||
summary: Get Connector List
|
||||
summary: Get connector list
|
||||
description: >-
|
||||
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
|
||||
parameters:
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCorrelationConfig
|
||||
tags:
|
||||
- Sources
|
||||
summary: Get Source Correlation Configuration
|
||||
summary: Get source correlation configuration
|
||||
security:
|
||||
- userAuth: [idn:sources:read, idn:sources:manage]
|
||||
x-sailpoint-userLevels:
|
||||
@@ -45,7 +45,7 @@ put:
|
||||
operationId: putCorrelationConfig
|
||||
tags:
|
||||
- Sources
|
||||
summary: Update Source Correlation Configuration
|
||||
summary: Update source correlation configuration
|
||||
security:
|
||||
- userAuth: [idn:sources:manage]
|
||||
x-sailpoint-userLevels:
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getCustomPasswordInstructions
|
||||
tags:
|
||||
- Custom Password Instructions
|
||||
summary: Get Custom Password Instructions by Page ID
|
||||
summary: Get custom password instructions by page id
|
||||
description: >-
|
||||
This API returns the custom password instructions for the specified page ID.
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
@@ -57,7 +57,7 @@ delete:
|
||||
operationId: deleteCustomPasswordInstructions
|
||||
tags:
|
||||
- Custom Password Instructions
|
||||
summary: Delete Custom Password Instructions by page ID
|
||||
summary: Delete custom password instructions by page id
|
||||
description: >-
|
||||
This API delete the custom password instructions for the specified page ID.
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: createCustomPasswordInstructions
|
||||
tags:
|
||||
- Custom Password Instructions
|
||||
summary: Create Custom Password Instructions
|
||||
summary: Create custom password instructions
|
||||
description: >-
|
||||
This API creates the custom password instructions for the specified page ID.
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getDataPipelineEvents
|
||||
tags:
|
||||
- IAI Data Pipeline Events
|
||||
summary: Get List of Pipeline events
|
||||
summary: Get list of pipeline events
|
||||
description: >-
|
||||
This presents a list of events and metadata for each pipeline of a customer.
|
||||
They are summarized per qualifier.
|
||||
@@ -66,7 +66,7 @@ post:
|
||||
operationId: postDataPipelineEvents
|
||||
tags:
|
||||
- IAI Data Pipeline Events
|
||||
summary: Creates Data Pipeline Event
|
||||
summary: Creates data pipeline event
|
||||
description: >-
|
||||
This creates a Data Pipeline Event for a customer in context.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ delete:
|
||||
operationId: deleteLifecycleState
|
||||
tags:
|
||||
- Lifecycle States
|
||||
summary: Lifecycle State Delete
|
||||
summary: Lifecycle state delete
|
||||
description: |
|
||||
This endpoint deletes a lifecycle state and updates the corresponding Identity Profile.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listDimensionAccessProfiles
|
||||
tags:
|
||||
- Dimensions
|
||||
summary: List Dimension's Access Profiles
|
||||
summary: List dimension's access profiles
|
||||
description: >-
|
||||
This API lists the Access Profiles associated with a given Dimension
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: deleteBulkDimensions
|
||||
summary: Delete Dimension(s)
|
||||
summary: Delete dimension(s)
|
||||
tags:
|
||||
- Dimensions
|
||||
description: >-
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getDimensionEntitlements
|
||||
tags:
|
||||
- Dimensions
|
||||
summary: List Dimension's Entitlements
|
||||
summary: List dimension's entitlements
|
||||
description: >-
|
||||
This API lists the Entitlements associated with a given dimension.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getDimension
|
||||
tags:
|
||||
- Dimensions
|
||||
summary: Get a Dimension under Role.
|
||||
summary: Get a dimension under role.
|
||||
description: >-
|
||||
This API returns a Dimension by its ID.
|
||||
|
||||
@@ -54,7 +54,7 @@ patch:
|
||||
operationId: patchDimension
|
||||
tags:
|
||||
- Dimensions
|
||||
summary: Patch a specified Dimension
|
||||
summary: Patch a specified dimension
|
||||
description: >-
|
||||
This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
|
||||
@@ -213,7 +213,7 @@ delete:
|
||||
operationId: deleteDimension
|
||||
tags:
|
||||
- Dimensions
|
||||
summary: Delete a Dimension
|
||||
summary: Delete a dimension
|
||||
description: >-
|
||||
This API deletes a Dimension by its ID.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listDimensions
|
||||
tags:
|
||||
- Dimensions
|
||||
summary: List Dimensions
|
||||
summary: List dimensions
|
||||
description: >-
|
||||
This API returns a list of dimensions under a specified role.
|
||||
|
||||
@@ -100,7 +100,7 @@ post:
|
||||
operationId: createDimension
|
||||
tags:
|
||||
- Dimensions
|
||||
summary: Create a Dimension
|
||||
summary: Create a dimension
|
||||
description: >-
|
||||
This API creates a dimension.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getDiscoveredApplicationByID
|
||||
tags:
|
||||
- Application Discovery
|
||||
summary: Get Discovered Application by ID
|
||||
summary: Get discovered application by id
|
||||
description: >
|
||||
Get the discovered application, along with with its associated sources, based on the provided ID.
|
||||
security:
|
||||
@@ -50,7 +50,7 @@ patch:
|
||||
operationId: patchDiscoveredApplicationByID
|
||||
tags:
|
||||
- Application Discovery
|
||||
summary: Patch Discovered Application by ID
|
||||
summary: Patch discovered application by id
|
||||
description: >-
|
||||
Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: listEntitlementsByIdentity
|
||||
tags:
|
||||
- Identities
|
||||
summary: List of entitlements by Identity.
|
||||
summary: List of entitlements by identity.
|
||||
description: >-
|
||||
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.
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getSourceApp
|
||||
tags:
|
||||
- Apps
|
||||
summary: Get source app by ID
|
||||
summary: Get source app by id
|
||||
description: >-
|
||||
This API returns a source app by its ID.
|
||||
security:
|
||||
@@ -39,7 +39,7 @@ patch:
|
||||
operationId: patchSourceApp
|
||||
tags:
|
||||
- Apps
|
||||
summary: Patch source app by ID
|
||||
summary: Patch source app by id
|
||||
description: >-
|
||||
This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
|
||||
@@ -182,7 +182,7 @@ delete:
|
||||
- userAuth: [idn:app-roles:manage, idn:app-roles:delete]
|
||||
tags:
|
||||
- Apps
|
||||
summary: Delete source app by ID
|
||||
summary: Delete source app by id
|
||||
description: >-
|
||||
Use this API to delete a specific source app
|
||||
parameters:
|
||||
|
||||
@@ -2,7 +2,7 @@ patch:
|
||||
operationId: patchUserApp
|
||||
tags:
|
||||
- Apps
|
||||
summary: Patch user app by ID
|
||||
summary: Patch user app by id
|
||||
description: >-
|
||||
This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ get:
|
||||
operationId: getEntitlementRequestConfig
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: Get Entitlement Request Config
|
||||
summary: Get entitlement request config
|
||||
description: >-
|
||||
This API returns the entitlement request config for a specified entitlement.
|
||||
security:
|
||||
@@ -89,7 +89,7 @@ put:
|
||||
operationId: putEntitlementRequestConfig
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: Replace Entitlement Request Config
|
||||
summary: Replace entitlement request config
|
||||
description: >-
|
||||
This API replaces the entitlement request config for a specified entitlement.
|
||||
security:
|
||||
|
||||
@@ -2,7 +2,7 @@ post:
|
||||
operationId: updateEntitlementSegmentAssignments
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: update entitlements of a segment
|
||||
summary: Update entitlements of a segment
|
||||
description: >-
|
||||
This internal endpoint assigns or removes entitlements to a segment
|
||||
requestBody:
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user