{"openapi":"3.0.3","info":{"title":"miniOrange API","description":"Generated from api-ref/spec JSON. Super Admin hash auth: `sha512(superAdminId + timestamp + apiKey)`. Set Super Admin ID, Target Customer ID, and API key in Try it.","version":"1.0.0"},"servers":[{"url":"https://login.xecurify.com/moas"},{"url":"https://superadminuser.miniorange.in"},{"url":"https://login.xecurify.com"}],"tags":[{"name":"Single Sign On","description":"SAML 2.0 SSO: send an AuthnRequest to miniOrange and receive the assertion at your ACS URL."},{"name":"Multi-Factor Authentication","description":"Challenge a user for a second factor and validate OTP, push, or authenticator tokens."},{"name":"Adaptive Multi-factor Authentication","description":"Risk-based adaptive MFA using device fingerprints and behavioral data."},{"name":"OpenID Connect","description":"OpenID Connect endpoints on top of OAuth 2.0: authorize, token, discovery, and JWKS."},{"name":"OAuth 2.0","description":"Authorization, token, user info, introspect, and revoke endpoints for miniOrange OAuth 2.0."},{"name":"User APIs","description":"Create, update, search, enable, disable, and delete users in your customer account."},{"name":"Magic Link Admin APIs","description":"Generate and revoke INVITE magic links for registered users and applications."},{"name":"Group APIs","description":"Fetch and update groups, and assign or remove users from groups."},{"name":"External SAML IdP","description":"Create, list, update, and delete external SAML identity providers."},{"name":"External OAuth IdP","description":"Create, list, update, and delete external OAuth identity providers."},{"name":"Users","description":"Super Admin cross-tenant APIs for Users."},{"name":"Groups","description":"Super Admin cross-tenant APIs for Groups."},{"name":"Applications","description":"Super Admin cross-tenant APIs for Applications."},{"name":"Authentication Policies","description":"Super Admin cross-tenant APIs for Authentication Policies."},{"name":"App Access Policy","description":"Super Admin cross-tenant APIs for App Access Policy."},{"name":"Identity Providers (IDPs)","description":"Super Admin cross-tenant APIs for Identity Providers (IDPs)."},{"name":"LDAP Directories","description":"Super Admin cross-tenant APIs for LDAP Directories."},{"name":"External DB Directories","description":"Super Admin cross-tenant APIs for External DB Directories."},{"name":"Roles & Capabilities","description":"Super Admin cross-tenant APIs for Roles & Capabilities."},{"name":"Password Policy","description":"Super Admin cross-tenant APIs for Password Policy."},{"name":"MFA Configuration","description":"Super Admin cross-tenant APIs for MFA Configuration."},{"name":"Hardware Tokens","description":"Super Admin cross-tenant APIs for Hardware Tokens."},{"name":"Custom Attributes","description":"Super Admin cross-tenant APIs for Custom Attributes."},{"name":"Security Codes","description":"Super Admin cross-tenant APIs for Security Codes."},{"name":"Login Alias Config","description":"Super Admin cross-tenant APIs for Login Alias Config."},{"name":"AWS Cognito Directories","description":"Super Admin cross-tenant APIs for AWS Cognito Directories."},{"name":"Web3 Directories","description":"Super Admin cross-tenant APIs for Web3 Directories."},{"name":"Provisioning","description":"Super Admin cross-tenant APIs for Provisioning."},{"name":"TACACS Vendors","description":"Super Admin cross-tenant APIs for TACACS Vendors."},{"name":"App Permissions","description":"Super Admin cross-tenant APIs for App Permissions."},{"name":"User Dashboard Details","description":"Super Admin cross-tenant APIs for User Dashboard Details."},{"name":"Delivery (SMTP)","description":"Super Admin cross-tenant APIs for Delivery (SMTP)."},{"name":"Bulk & Import APIs","description":"Super Admin cross-tenant APIs for Bulk & Import APIs."},{"name":"MultiBranding","description":"Super Admin cross-tenant APIs for MultiBranding."},{"name":"Delete Duplicate EndUser","description":"Super Admin cross-tenant APIs for Delete Duplicate EndUser."}],"paths":{"/idp/samlsso":{"get":{"tags":["Single Sign On"],"summary":"Send SAML AuthnRequest","operationId":"send-saml-authnrequest","parameters":[{"name":"SAMLRequest","in":"query","required":true,"schema":{"type":"string"},"description":"Deflated and Base64-encoded AuthnRequest XML"},{"name":"RelayState","in":"query","required":false,"schema":{"type":"string"},"description":"Returned unchanged after login"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Redirect the browser with a deflated, Base64-encoded SAMLRequest."}},"/samlresponse":{"post":{"tags":["Single Sign On"],"summary":"Assertion Consumer Service","operationId":"assertion-consumer-service","parameters":[{"name":"SAMLResponse","in":"query","required":true,"schema":{"type":"string"},"description":"Base64-encoded SAML Response"},{"name":"RelayState","in":"query","required":false,"schema":{"type":"string"},"description":"Original RelayState"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Your app endpoint that receives the SAMLResponse."}},"/api/auth/challenge":{"post":{"tags":["Multi-Factor Authentication"],"summary":"Challenge","operationId":"challenge","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Enrolled user email"},{"name":"authType","in":"query","required":false,"schema":{"type":"string"},"description":"SMS, EMAIL, OUT OF BAND SMS, OUT OF BAND EMAIL, PHONE VERIFICATION, PUSH NOTIFICATIONS, MOBILE AUTHENTICATION, VOICE AUTHENTICATION"},{"name":"transactionName","in":"query","required":false,"schema":{"type":"string"},"description":"Shown to the user. Max 30 characters"}],"responses":{"200":{"description":"Success","content":{"application/json":{"example":{"txId":"ba65583b-7c80-11e5-883e-0e2fb063e0f9","authType":"SMS","responseType":"CHALLENGE","status":"SUCCESS"}}}},"401":{"description":"Unauthorized"}},"description":"Start an MFA challenge for a user.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"customerKey":"12345","username":"alex@example.com","authType":"SMS"}}}}}},"/api/auth/validate":{"post":{"tags":["Multi-Factor Authentication"],"summary":"Validate OTP","operationId":"validate-otp","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Enrolled user email"},{"name":"txId","in":"query","required":false,"schema":{"type":"string"},"description":"Transaction ID from Challenge (not needed for Soft Token / Google Authenticator)"},{"name":"token","in":"query","required":true,"schema":{"type":"string"},"description":"OTP or authenticator code"},{"name":"authType","in":"query","required":false,"schema":{"type":"string"},"description":"SOFT TOKEN, GOOGLE AUTHENTICATOR, HARDWARE TOKEN, SMS, EMAIL"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Validate the OTP or token for a challenge.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"customerKey":"12345","username":"alex@example.com","token":"123456","authType":"SOFT TOKEN"}}}}}},"/api/auth/google-auth-secret":{"post":{"tags":["Multi-Factor Authentication"],"summary":"Register Google Authenticator","operationId":"register-google-authenticator","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"User login name"},{"name":"authenticatorType","in":"query","required":true,"schema":{"type":"string"},"description":"GOOGLE AUTHENTICATOR"},{"name":"otpToken","in":"query","required":false,"schema":{"type":"string"},"description":"OTP when confirming a secret"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Register Google Authenticator for a user."}},"/api/auth/validate-google-auth-secret":{"post":{"tags":["Multi-Factor Authentication"],"summary":"Validate Google Authenticator","operationId":"validate-google-authenticator","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"User login name"},{"name":"authenticatorType","in":"query","required":true,"schema":{"type":"string"},"description":"GOOGLE AUTHENTICATOR"},{"name":"otpToken","in":"query","required":true,"schema":{"type":"string"},"description":"Six-digit code"},{"name":"secret","in":"query","required":true,"schema":{"type":"string"},"description":"Secret from register"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Validate a Google Authenticator OTP."}},"/api/auth/adaptive/is-registered":{"post":{"tags":["Adaptive Multi-factor Authentication"],"summary":"Is User Registered","operationId":"is-user-registered","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Customer ID"},{"name":"email","in":"query","required":true,"schema":{"type":"string"},"description":"User email"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Check whether the user is enrolled for Adaptive MFA."}},"/api/auth/adaptive/register":{"post":{"tags":["Adaptive Multi-factor Authentication"],"summary":"Register User","operationId":"register-user","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Customer ID"},{"name":"email","in":"query","required":true,"schema":{"type":"string"},"description":"User email"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Register the current user and device fingerprint."}},"/idp/openidsso":{"get":{"tags":["OAuth 2.0"],"summary":"Authorization request","operationId":"authorization-request-2","parameters":[{"name":"client_id","in":"query","required":true,"schema":{"type":"string"},"description":"OAuth client ID"},{"name":"redirect_uri","in":"query","required":true,"schema":{"type":"string"},"description":"Registered callback URL"},{"name":"scope","in":"query","required":true,"schema":{"type":"string"},"description":"email / profile / openid"},{"name":"response_type","in":"query","required":true,"schema":{"type":"string"},"description":"code"},{"name":"state","in":"query","required":true,"schema":{"type":"string"},"description":"CSRF token"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Redirect the browser. Callback receives code and state."}},"/rest/oauth/token":{"post":{"tags":["OAuth 2.0"],"summary":"Refresh token","operationId":"refresh-token-4","parameters":[{"name":"grant_type","in":"query","required":true,"schema":{"type":"string"},"description":"refresh_token"},{"name":"refresh_token","in":"query","required":true,"schema":{"type":"string"},"description":"Previously issued refresh token"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Request a new access token."}},"/.well-known/openid-configuration":{"get":{"tags":["OpenID Connect"],"summary":"Discovery","operationId":"discovery","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"OpenID Provider metadata."}},"/.well-known/jwks":{"get":{"tags":["OpenID Connect"],"summary":"JWKS","operationId":"jwks","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"JSON Web Key Set for ID token validation."}},"/rest/oauth/introspect":{"post":{"tags":["OAuth 2.0"],"summary":"Introspect token","operationId":"introspect-token-2","parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string"},"description":"Access token or ID token"},{"name":"client_id","in":"query","required":true,"schema":{"type":"string"},"description":"OAuth client ID"},{"name":"client_secret","in":"query","required":true,"schema":{"type":"string"},"description":"OAuth client secret"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Check whether a token is active."}},"/idp/oidc/logout":{"get":{"tags":["OpenID Connect"],"summary":"Single Logout","operationId":"single-logout","parameters":[{"name":"post_logout_redirect_uri","in":"query","required":false,"schema":{"type":"string"},"description":"Where to send the user after logout"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"End the OpenID session."}},"/rest/oauth/getuserinfo":{"get":{"tags":["OAuth 2.0"],"summary":"User info","operationId":"user-info","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Fetch the authenticated user profile."}},"/rest/oauth/revoke":{"post":{"tags":["OAuth 2.0"],"summary":"Revoke token","operationId":"revoke-token","parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string"},"description":"Token to revoke"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Revoke a granted access token."}},"/api/admin/users/create":{"post":{"tags":["User APIs"],"summary":"Create User","operationId":"create-user","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Unique login name, usually the email"},{"name":"password","in":"query","required":false,"schema":{"type":"string"},"description":"Initial password"},{"name":"firstName","in":"query","required":false,"schema":{"type":"string"},"description":"First name"},{"name":"lastName","in":"query","required":false,"schema":{"type":"string"},"description":"Last name"},{"name":"email","in":"query","required":false,"schema":{"type":"string"},"description":"Email address"},{"name":"phone","in":"query","required":false,"schema":{"type":"string"},"description":"Phone number"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Create a user.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"customerKey":"12345","username":"john@example.com","email":"john@example.com","firstName":"John","lastName":"Doe"}}}}}},"/api/admin/users/update":{"post":{"tags":["User APIs"],"summary":"Update User","operationId":"update-user","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Existing username"},{"name":"firstName","in":"query","required":false,"schema":{"type":"string"},"description":"Updated first name"},{"name":"lastName","in":"query","required":false,"schema":{"type":"string"},"description":"Updated last name"},{"name":"email","in":"query","required":false,"schema":{"type":"string"},"description":"Updated email"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Update an existing user."}},"/api/admin/users/getall":{"post":{"tags":["User APIs"],"summary":"Get All Users","operationId":"get-all-users","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"batchSize","in":"query","required":false,"schema":{"type":"integer"},"description":"Users per page. Maximum 500"},{"name":"batchNo","in":"query","required":false,"schema":{"type":"integer"},"description":"1-based page number"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Returns users in batches (max 500 per batch).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"customerKey":"12345","batchSize":100,"batchNo":1}}}}}},"/api/admin/users/get":{"post":{"tags":["User APIs"],"summary":"Get User","operationId":"get-user","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Username or email"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Fetch a single user."}},"/api/admin/users/delete":{"post":{"tags":["User APIs"],"summary":"Delete User","operationId":"delete-user","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Username to delete"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Delete a user."}},"/api/admin/users/disable":{"post":{"tags":["User APIs"],"summary":"Disable User","operationId":"disable-user","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Username to disable"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Disable a user account."}},"/api/admin/users/enable":{"post":{"tags":["User APIs"],"summary":"Enable User","operationId":"enable-user","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Username to enable"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Enable a user account."}},"/api/admin/users/stats/count":{"get":{"tags":["User APIs"],"summary":"Fetch End User Count","operationId":"fetch-end-user-count","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Return the number of end users."}},"/api/admin/users/change-password":{"post":{"tags":["User APIs"],"summary":"Change User Password","operationId":"change-user-password","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Username"},{"name":"password","in":"query","required":true,"schema":{"type":"string"},"description":"New password"},{"name":"oldPassword","in":"query","required":true,"schema":{"type":"string"},"description":"Current password"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Change a user password.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"customerKey":"12345","username":"demouser","password":"Passw0rd.","oldPassword":"user@123"}}}}}},"/api/admin/magiclink/generate":{"post":{"tags":["Magic Link Admin APIs"],"summary":"Generate Magic Link","operationId":"generate-magic-link","parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Username or primary email (2–100 characters)"},{"name":"applicationUuid","in":"query","required":true,"schema":{"type":"string"},"description":"Application UUID from the admin console"},{"name":"redirectUri","in":"query","required":false,"schema":{"type":"string"},"description":"Post-login URL. Required for JWT apps."},{"name":"expiryMinutes","in":"query","required":false,"schema":{"type":"integer"},"description":"Validity in minutes. Default 15, max 43200"}],"responses":{"200":{"description":"Success","content":{"application/json":{"example":{"status":"SUCCESS","message":"Magic link sent successfully.","correlationId":"a3f7c129-8e4d-4b21-bcd3-0fae7a90e15d"}}}},"401":{"description":"Unauthorized"}},"description":"Send an INVITE magic link to the user email. The link is not returned in the response.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"username":"jane.doe@example.com","applicationUuid":"60237c5a-5fdf-11f1-adc7-d2e94289769e","redirectUri":"https://app.example.com/callback","expiryMinutes":60}}}}}},"/api/admin/magiclink/revoke":{"post":{"tags":["Magic Link Admin APIs"],"summary":"Revoke Magic Link","operationId":"revoke-magic-link","parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string"},"description":"Username or primary email"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Revoke active INVITE magic links for a user.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"username":"jane.doe@example.com"}}}}}},"/api/admin/groups/getall":{"post":{"tags":["Group APIs"],"summary":"Get All Groups","operationId":"get-all-groups","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"batchSize","in":"query","required":false,"schema":{"type":"integer"},"description":"Groups per page"},{"name":"batchNo","in":"query","required":false,"schema":{"type":"integer"},"description":"1-based page number"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"List groups in batches.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":{"customerKey":"123","batchSize":10,"batchNo":1}}}}}},"/api/admin/groups/update":{"post":{"tags":["Group APIs"],"summary":"Update Group","operationId":"update-group","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"groupName","in":"query","required":true,"schema":{"type":"string"},"description":"Existing group name"},{"name":"newGroupName","in":"query","required":false,"schema":{"type":"string"},"description":"Renamed group name"},{"name":"description","in":"query","required":false,"schema":{"type":"string"},"description":"Group description"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Update an existing group."}},"/api/admin/groups/members/update":{"post":{"tags":["Group APIs"],"summary":"Update Group Members","operationId":"update-group-members","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"groupName","in":"query","required":true,"schema":{"type":"string"},"description":"Target group"},{"name":"usernamesToAdd","in":"query","required":false,"schema":{"type":"array"},"description":"Users to assign"},{"name":"usernamesToRemove","in":"query","required":false,"schema":{"type":"array"},"description":"Users to remove"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Add or remove users from a group."}},"/api/admin/groups/members":{"post":{"tags":["Group APIs"],"summary":"Get User-Group Mappings","operationId":"get-user-group-mappings","parameters":[{"name":"customerKey","in":"query","required":true,"schema":{"type":"string"},"description":"Your customer key"},{"name":"groupName","in":"query","required":false,"schema":{"type":"string"},"description":"Optional group filter"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"List users in custom groups."}},"/services/api/idps/v1/saml":{"get":{"tags":["External SAML IdP"],"summary":"List SAML IdPs","operationId":"list-saml-idps","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"integer"},"description":"Defaults to 1"},{"name":"count","in":"query","required":false,"schema":{"type":"integer"},"description":"Defaults to 10"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Get all configured SAML IdPs."},"post":{"tags":["External SAML IdP"],"summary":"Create SAML IdP","operationId":"create-saml-idp","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Create an external SAML IdP."}},"/services/api/idps/v1/saml/{uuid}":{"get":{"tags":["External SAML IdP"],"summary":"Get SAML IdP","operationId":"get-saml-idp","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"IdP UUID"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Get one SAML IdP by UUID."},"put":{"tags":["External SAML IdP"],"summary":"Update SAML IdP","operationId":"update-saml-idp","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"IdP UUID"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Update an external SAML IdP."},"delete":{"tags":["External SAML IdP"],"summary":"Delete SAML IdP","operationId":"delete-saml-idp","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"IdP UUID"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Delete an external SAML IdP."}},"/services/api/idps/v1/oauth":{"get":{"tags":["External OAuth IdP"],"summary":"List OAuth IdPs","operationId":"list-oauth-idps","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"integer"},"description":"Defaults to 1"},{"name":"count","in":"query","required":false,"schema":{"type":"integer"},"description":"Defaults to 10"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Get all configured OAuth IdPs."},"post":{"tags":["External OAuth IdP"],"summary":"Create OAuth IdP","operationId":"create-oauth-idp","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Create an external OAuth IdP."}},"/services/api/idps/v1/oauth/{uuid}":{"get":{"tags":["External OAuth IdP"],"summary":"Get OAuth IdP","operationId":"get-oauth-idp","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"IdP UUID"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Get one OAuth IdP by UUID."},"put":{"tags":["External OAuth IdP"],"summary":"Update OAuth IdP","operationId":"update-oauth-idp","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"IdP UUID"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Update an external OAuth IdP."},"delete":{"tags":["External OAuth IdP"],"summary":"Delete OAuth IdP","operationId":"delete-oauth-idp","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"IdP UUID"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Delete an external OAuth IdP."}},"/services/api/directory/v1/admin/users":{"get":{"tags":["Users"],"summary":"1.1 List Users (paginated)","operationId":"1-1-list-users-paginated","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"Zero-based start index for pagination","example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of results per page","example":"10"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Users"],"summary":"1.4 Create User","operationId":"1-4-create-user","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":""},"username":{"type":"string","description":""},"firstName":{"type":"string","description":""},"lastName":{"type":"string","description":""},"phone":{"type":"string","description":""}}},"example":{"email":"newuser@example.com","username":"newuser","firstName":"New","lastName":"User","phone":"+1234567890"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/search":{"get":{"tags":["Users"],"summary":"1.2 Search User by Username or Email","operationId":"1-2-search-user-by-username-or-email","parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string"},"example":"john@example.com"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/{guid}":{"get":{"tags":["Users"],"summary":"1.3 Get User by GUID","operationId":"1-3-get-user-by-guid","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<user-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/username-constraints":{"get":{"tags":["Users"],"summary":"1.5 Get Username Constraints","operationId":"1-5-get-username-constraints","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/{userGuid}/assign-groups":{"post":{"tags":["Users"],"summary":"1.6 Assign User to Multiple Groups","operationId":"1-6-assign-user-to-multiple-groups","parameters":[{"name":"userGuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<user-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupList":{"type":"string","description":""}}},"example":{"groupList":["aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb","cccccccc-4444-5555-6666-dddddddddddd"]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/{guid}/available-groups":{"get":{"tags":["Users"],"summary":"1.7 Get Groups Available to Assign to a User","operationId":"1-7-get-groups-available-to-assign-to-a-user","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"example":"10"},{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<user-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/onboarding-status":{"get":{"tags":["Users"],"summary":"1.8 Get Onboarding Status","operationId":"1-8-get-onboarding-status","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Get user onboarding status summary for the target tenant.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/columns":{"get":{"tags":["Users"],"summary":"1.9 Get User Table Column Config","operationId":"1-9-get-user-table-column-config","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Retrieve the current user table column display configuration for the target tenant.","security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Users"],"summary":"1.10 Update User Table Column Config","operationId":"1-10-update-user-table-column-config","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Update the user table column display configuration. Set each column key to true (visible) or false (hidden).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"guid":{"type":"string","description":""},"primaryEmail":{"type":"string","description":""},"username":{"type":"string","description":""},"endUserName":{"type":"string","description":""},"creationDttm":{"type":"string","description":""},"lastUpdatedDttm":{"type":"string","description":""},"lastVerifiedDttm":{"type":"string","description":""},"primaryPhone":{"type":"string","description":""},"secondFactorAuthType":{"type":"string","description":""},"deviceLimit":{"type":"string","description":""},"role":{"type":"string","description":""},"passwordExpiryDate":{"type":"string","description":""},"lastSuccessfulLogin":{"type":"string","description":""},"customAttribute1":{"type":"string","description":""},"customAttribute2":{"type":"string","description":""},"sourceType":{"type":"string","description":""},"fname":{"type":"string","description":""},"lname":{"type":"string","description":""},"group":{"type":"string","description":""},"lastUnsuccessfulLoginTry":{"type":"string","description":""}}},"example":{"guid":true,"primaryEmail":true,"username":true,"endUserName":true,"creationDttm":false,"lastUpdatedDttm":true,"lastVerifiedDttm":false,"primaryPhone":false,"secondFactorAuthType":false,"deviceLimit":true,"role":true,"passwordExpiryDate":true,"lastSuccessfulLogin":true,"customAttribute1":false,"customAttribute2":false,"sourceType":false,"fname":true,"lname":true,"group":false,"lastUnsuccessfulLoginTry":false}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/{guid}/active-sessions":{"delete":{"tags":["Users"],"summary":"1.13 Delete Active Sessions for User","operationId":"1-13-delete-active-sessions-for-user","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<user-guid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Terminate all active sessions for a specific user in the target tenant (force logout).","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/groups":{"get":{"tags":["Groups"],"summary":"2.1 List Groups (paginated)","operationId":"2-1-list-groups-paginated","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"example":"10"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Groups"],"summary":"2.3 Create Group","operationId":"2-3-create-group","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupName":{"type":"string","description":""},"displayName":{"type":"string","description":""},"groupAttributes":{"type":"string","description":""}}},"example":{"groupName":"Engineering","displayName":"Engineering department group","groupAttributes":[]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Groups"],"summary":"2.5 Delete Group(s)","operationId":"2-5-delete-group-s","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":["aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb","cccccccc-4444-5555-6666-dddddddddddd"]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/groups/{guid}":{"get":{"tags":["Groups"],"summary":"2.2 Get Group by GUID","operationId":"2-2-get-group-by-guid","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<group-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Groups"],"summary":"2.4 Update Group","operationId":"2-4-update-group","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"dd19df56-b532-4779-8a20-f5f543cce95f"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":""},"groupAttributes":{"type":"string","description":""}}},"example":{"displayName":"New Display Name","groupAttributes":[]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/groups/default":{"patch":{"tags":["Groups"],"summary":"2.6 Set Group as Default","operationId":"2-6-set-group-as-default","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupUuid":{"type":"string","description":""},"isDefault":{"type":"string","description":""}}},"example":{"groupUuid":"<group-uuid>","isDefault":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/groups/{guid}/users":{"get":{"tags":["Groups"],"summary":"2.7 Get Users in a Group","operationId":"2-7-get-users-in-a-group","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"example":"10"},{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<group-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Groups"],"summary":"2.11 Remove Users from Group","operationId":"2-11-remove-users-from-group-2","parameters":[{"name":"action","in":"query","required":false,"schema":{"type":"string"},"description":"Use 'assign' to add users, 'deassign' to remove users","example":"deassign"},{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<group-guid>"}],"responses":{"200":{"description":"Success","content":{"application/json":{"example":{"status":"SUCCESS","message":"User(s) removed from group successfully."}}}},"401":{"description":"Unauthorized"}},"description":"Removes one or more users from a group. Set query parameter action to deassign and pass user GUIDs in the userList body field.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userList":{"type":"string","description":""}}},"example":{"userList":["<user-guid>"]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/groups/{guid}/available-users":{"get":{"tags":["Groups"],"summary":"2.8 Get Users NOT in a Group","operationId":"2-8-get-users-not-in-a-group","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"example":"10"},{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<group-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Returns users NOT yet in the group. Use for bulk-add scenarios.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/groups/user/{userGuid}":{"get":{"tags":["Groups"],"summary":"2.9 Get All Groups for a User","operationId":"2-9-get-all-groups-for-a-user","parameters":[{"name":"userGuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<user-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/apps":{"get":{"tags":["Applications"],"summary":"3.1 List Apps (paginated)","operationId":"3-1-list-apps-paginated","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"example":"100"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Applications"],"summary":"3.3 Create App (generic — NOT for SAML)","operationId":"3-3-create-app-generic-not-for-saml","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"appUuid":{"type":"string","description":""},"customApplicationName":{"type":"string","description":""},"application_name":{"type":"string","description":""},"appType":{"type":"string","description":""},"description":{"type":"string","description":""},"spEntityId":{"type":"string","description":""},"acsUrl":{"type":"string","description":""}}},"example":{"appUuid":"5aac7bac-5f22-4855-86bf-56009a028cb3","customApplicationName":"My SAML App","application_name":"Custom SAML App","appType":"SAML","description":"Test app","spEntityId":"https://sp.example.com/entity","acsUrl":"https://sp.example.com/acs"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/apps/{uuid}":{"get":{"tags":["Applications"],"summary":"3.2 Get App by UUID","operationId":"3-2-get-app-by-uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"give <uuid> , not <app-uuid>","example":"c8d7d819-c148-11f0-87d4-0242ac13000a"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3.4 Update App","operationId":"3-4-update-app","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"f20dffd3-599c-11f1-9f15-a604e67300e4"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customApplicationName":{"type":"string","description":""},"showOnEnduserDashboard":{"type":"string","description":""},"sloEnabled":{"type":"string","description":""},"ssoFlows":{"type":"string","description":""},"useCustomersIdp":{"type":"string","description":""},"isMultivaluedAttributesEnabled":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""}}},"example":{"customApplicationName":"My SAML Applicationssss","showOnEnduserDashboard":false,"sloEnabled":true,"ssoFlows":"idp","useCustomersIdp":false,"isMultivaluedAttributesEnabled":false,"isSharedAccount":false}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3.5 Delete App","operationId":"3-5-delete-app","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"test with app-uuid or uuid , one will work.","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/apps/{appUuid}/groups":{"post":{"tags":["Applications"],"summary":"3.6 Assign Groups to App","operationId":"3-6-assign-groups-to-app","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"use <uuid>, not <app-uuid>","example":"a31228cc-c13c-11f0-87d4-0242ac13000a"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string","description":""},"groups":{"type":"string","description":""},"firstFactorAuthType":{"type":"string","description":""},"isSecondFactorMandatory":{"type":"string","description":""},"secondFactorAuthType":{"type":"string","description":""},"enableRbaIP":{"type":"string","description":""},"enableRbaDevice":{"type":"string","description":""},"force_2faOnLogin":{"type":"string","description":""}}},"example":{"app":{"id":"a31228cc-c13c-11f0-87d4-0242ac13000a","name":"CognitoProv"},"groups":[{"id":"26dfe9a6-de2c-4370-a161-8af04fd8d8a6","name":"G1"},{"id":"27a06621-e0ce-4b6e-9384-511ce46b2b77","name":"G2"}],"firstFactorAuthType":"PASSWORD","isSecondFactorMandatory":false,"secondFactorAuthType":"EMAIL","enableRbaIP":false,"enableRbaDevice":false,"force_2faOnLogin":false}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3.7 Unassign Groups from App","operationId":"3-7-unassign-groups-from-app","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"use <uuid> , not <app-uuid>","example":"a31228cc-c13c-11f0-87d4-0242ac13000a"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":["26dfe9a6-de2c-4370-a161-8af04fd8d8a6","27a06621-e0ce-4b6e-9384-511ce46b2b77"]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/apps/{appGuid}/users":{"get":{"tags":["Applications"],"summary":"3.8 Get Users Associated to App","operationId":"3-8-get-users-associated-to-app","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"example":"10"},{"name":"appGuid","in":"path","required":true,"schema":{"type":"string"},"description":"provide <uuid> , not <app-uuid>","example":"a31228cc-c13c-11f0-87d4-0242ac13000a"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/apps/{appGuid}/groups":{"get":{"tags":["Applications"],"summary":"3.9 Get Groups Associated to App","operationId":"3-9-get-groups-associated-to-app","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"example":"10"},{"name":"appGuid","in":"path","required":true,"schema":{"type":"string"},"description":"use <uuid> , not <app-uuid>","example":"a31228cc-c13c-11f0-87d4-0242ac13000a"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/preconfig-apps":{"get":{"tags":["Applications"],"summary":"3.10 Get Preconfigured Apps","operationId":"3-10-get-preconfigured-apps","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/saml/idp-entity-id":{"get":{"tags":["Applications"],"summary":"3B.1 Get IDP Entity ID","operationId":"3b-1-get-idp-entity-id","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Returns the IDP Entity ID for the tenant's SAML configuration.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/saml":{"post":{"tags":["Applications"],"summary":"3B.2 Create SAML App","operationId":"3b-2-create-saml-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"appName":{"type":"string","description":""},"applicationName":{"type":"string","description":""},"nameIdAttribute":{"type":"string","description":""},"nameIdFormat":{"type":"string","description":""},"createDefaultPolicy":{"type":"string","description":""},"serviceProviderDetails":{"type":"string","description":""},"settings":{"type":"string","description":""},"attributeMappings":{"type":"string","description":""}}},"example":{"appName":"My SAML App","applicationName":"Custom SAML App","nameIdAttribute":"EMAIL","nameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified","createDefaultPolicy":false,"serviceProviderDetails":{"acsUrl":"https://sp.example.com/acs","spEntityId":"https://sp.example.com","audienceUri":"https://sp.example.com","spSingleLogoutUrl":"https://sp.example.com","isRequestSigned":false,"spCertificate":"","useEntityIdAsAudience":false},"settings":{"isResponseSigned":true,"isAssertionSigned":false,"signatureAlgorithm":"RSA-SHA256","encryptionAlgorithm":"aes256-cbc","nameFormat":"urn:oasis:names:tc:SAML:2.0:attrname-format:basic","responseTimeValid":300,"logoutResponseBinding":"POST","logoutRequestBinding":"REDIRECT","showOnEndUserDashboard":false,"assertionEncryption":false},"attributeMappings":[{"attributeName":"Email","attributeType":"MINIORANGE","attributeValue":"EMAIL"},{"attributeName":"FirstName","attributeType":"MINIORANGE","attributeValue":"FIRST_NAME"},{"attributeName":"LastName","attributeType":"MINIORANGE","attributeValue":"LAST_NAME"}]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/saml/{appUuid}":{"get":{"tags":["Applications"],"summary":"3B.3 Get SAML App","operationId":"3b-3-get-saml-app","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"SAML app <uuid> , not <app-uuid>","example":"85efac43-3d79-11f1-bf06-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3B.4 Update SAML App","operationId":"3b-4-update-saml-app","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"SAML app UUID","example":"85efac43-3d79-11f1-bf06-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"appName":{"type":"string","description":""},"applicationName":{"type":"string","description":""},"nameIdAttribute":{"type":"string","description":""},"nameIdFormat":{"type":"string","description":""},"serviceProviderDetails":{"type":"string","description":""},"settings":{"type":"string","description":""},"attributeMappings":{"type":"string","description":""}}},"example":{"appName":"My SAML App Updated","applicationName":"Custom SAML App","nameIdAttribute":"EMAIL","nameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified","serviceProviderDetails":{"acsUrl":"https://sp.example.com/acs","spEntityId":"https://sp.example.com","audienceUri":"https://sp.example.com","spSingleLogoutUrl":null,"isRequestSigned":false,"spCertificate":"","useEntityIdAsAudience":false},"settings":{"isResponseSigned":true,"isAssertionSigned":false,"signatureAlgorithm":"RSA-SHA256","encryptionAlgorithm":"aes256-cbc","nameFormat":"urn:oasis:names:tc:SAML:2.0:attrname-format:basic","isNameFormatEnabled":false,"responseTimeValid":300,"isForceAuthnEnabled":false,"logoutResponseBinding":"POST","logoutRequestBinding":"REDIRECT","overrideRelayState":false,"assertionEncryption":false},"attributeMappings":[{"attributeName":"Email","attributeType":"MINIORANGE","attributeValue":"EMAIL"},{"attributeName":"FirstName","attributeType":"MINIORANGE","attributeValue":"FIRST_NAME"},{"attributeName":"LastName","attributeType":"MINIORANGE","attributeValue":"LAST_NAME"}]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3B.5 Delete SAML App","operationId":"3b-5-delete-saml-app","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"SAML app <uuid> , not <app-uuid>","example":"85efac43-3d79-11f1-bf06-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/saml/{appUuid}/reset-keys":{"patch":{"tags":["Applications"],"summary":"3B.6 Reset SAML Keys","operationId":"3b-6-reset-saml-keys","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"SAML app <uuid>, not <app-uuid>","example":"5e053fe9-3d7b-11f1-bf06-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Regenerates the SAML signing certificate/keys for this app.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/saml/{appUuid}/metadata":{"get":{"tags":["Applications"],"summary":"3B.7 Get SAML Metadata","operationId":"3b-7-get-saml-metadata","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"SAML app <uuid>, not <app-uuid>","example":"5e053fe9-3d7b-11f1-bf06-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/saml/{appUuid}/sso-link":{"get":{"tags":["Applications"],"summary":"3B.8 Get SAML SSO Link","operationId":"3b-8-get-saml-sso-link","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"SAML app UUID","example":"5e053fe9-3d7b-11f1-bf06-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/saml/{uuid}/update-certificate":{"put":{"tags":["Applications"],"summary":"3B.9 Update SAML Certificate","operationId":"3b-9-update-saml-certificate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"SAML app <uuid>, not <app-uuid>","example":"5e053fe9-3d7b-11f1-bf06-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"privateKey":{"type":"string","description":""},"certificate":{"type":"string","description":""}}},"example":{"privateKey":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC...\n-----END PRIVATE KEY-----","certificate":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAKlxyz123456MA0GCSqGSIb3DQEB...\n-----END CERTIFICATE-----"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/saml/upload-metadata":{"post":{"tags":["Applications"],"summary":"3B.10 Upload SAML Metadata (XML)","operationId":"3b-10-upload-saml-metadata-xml","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Upload SP metadata XML file. Use form-data body with key 'file'.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/openid":{"post":{"tags":["Applications"],"summary":"3C.1 Create OAuth/OIDC App","operationId":"3c-1-create-oauth-oidc-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"applicationName":{"type":"string","description":""},"clientName":{"type":"string","description":""},"clientDesc":{"type":"string","description":""},"redirectUrls":{"type":"string","description":""},"allowedLogoutUrls":{"type":"string","description":""},"clientId":{"type":"string","description":""},"clientSecret":{"type":"string","description":""},"accessTokenExpiry":{"type":"integer","description":""},"jwtExpiry":{"type":"integer","description":""},"refreshTokenExpiry":{"type":"integer","description":""},"subject":{"type":"string","description":""},"subjectAttributeValue":{"type":"string","description":""},"algo":{"type":"string","description":""},"ssoFlows":{"type":"string","description":""},"forceAuthn":{"type":"string","description":""},"sloEnabled":{"type":"string","description":""},"createDefaultPolicy":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""},"isCustomerIdpEnabled":{"type":"string","description":""},"isMultivaluedAttributesEnabled":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"customerScopes":{"type":"string","description":""},"customLoginPageUrl":{"type":"string","description":""},"identitySource":{"type":"string","description":""},"attributeMappings":{"type":"string","description":""}}},"example":{"applicationName":"OAuth2/OpenID Connect","clientName":"My OAuth App","clientDesc":"Description of my OAuth OIDC app","redirectUrls":["https://myapp.example.com/callback","https://myapp.example.com/auth/callback"],"allowedLogoutUrls":["https://myapp.example.com/logout"],"clientId":null,"clientSecret":null,"accessTokenExpiry":1,"jwtExpiry":1,"refreshTokenExpiry":14,"subject":"EMAIL","subjectAttributeValue":null,"algo":"RSA-SHA256","ssoFlows":"idp","forceAuthn":false,"sloEnabled":true,"createDefaultPolicy":false,"showOnEndUserDashboard":false,"isCustomerIdpEnabled":false,"isMultivaluedAttributesEnabled":false,"isSharedAccount":false,"customerScopes":null,"customLoginPageUrl":null,"identitySource":null,"attributeMappings":[{"attributeName":"email","attributeType":"MINIORANGE","attributeValue":"EMAIL"},{"attributeName":"firstName","attributeType":"MINIORANGE","attributeValue":"FIRST_NAME"},{"attributeName":"lastName","attributeType":"MINIORANGE","attributeValue":"LAST_NAME"}]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/openid/{appUuid}":{"get":{"tags":["Applications"],"summary":"3C.2 Get OAuth/OIDC App","operationId":"3c-2-get-oauth-oidc-app","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"OAuth app <uuid>, not <app-uuid>","example":"14c4f897-3d8a-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3C.3 Update OAuth/OIDC App","operationId":"3c-3-update-oauth-oidc-app","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"OAuth app <uuid>, not <app-uuid>","example":"14c4f897-3d8a-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"applicationName":{"type":"string","description":""},"clientName":{"type":"string","description":""},"clientDesc":{"type":"string","description":""},"redirectUrls":{"type":"string","description":""},"allowedLogoutUrls":{"type":"string","description":""},"clientId":{"type":"string","description":""},"clientSecret":{"type":"string","description":""},"accessTokenExpiry":{"type":"integer","description":""},"jwtExpiry":{"type":"integer","description":""},"refreshTokenExpiry":{"type":"integer","description":""},"subject":{"type":"string","description":""},"subjectAttributeValue":{"type":"string","description":""},"algo":{"type":"string","description":""},"ssoFlows":{"type":"string","description":""},"forceAuthn":{"type":"string","description":""},"sloEnabled":{"type":"string","description":""},"createDefaultPolicy":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""},"isCustomerIdpEnabled":{"type":"string","description":""},"isMultivaluedAttributesEnabled":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"customerScopes":{"type":"string","description":""},"customLoginPageUrl":{"type":"string","description":""},"identitySource":{"type":"string","description":""},"attributeMappings":{"type":"string","description":""}}},"example":{"applicationName":"OAuth2/OpenID Connect","clientName":"My OAuth App Updated","clientDesc":"Updated description","redirectUrls":["https://myapp.example.com/callback","https://myapp.example.com/auth/v2/callback"],"allowedLogoutUrls":["https://myapp.example.com/logout"],"clientId":"<existing-client-id>","clientSecret":"<existing-client-secret>","accessTokenExpiry":2,"jwtExpiry":1,"refreshTokenExpiry":30,"subject":"EMAIL","subjectAttributeValue":null,"algo":"RSA-SHA256","ssoFlows":"idp","forceAuthn":false,"sloEnabled":true,"createDefaultPolicy":false,"showOnEndUserDashboard":false,"isCustomerIdpEnabled":false,"isMultivaluedAttributesEnabled":false,"isSharedAccount":false,"customerScopes":"openid,profile,email","customLoginPageUrl":null,"identitySource":null,"attributeMappings":[{"attributeName":"email","attributeType":"MINIORANGE","attributeValue":"EMAIL"},{"attributeName":"firstName","attributeType":"MINIORANGE","attributeValue":"FIRST_NAME"},{"attributeName":"lastName","attributeType":"MINIORANGE","attributeValue":"LAST_NAME"}]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3C.4 Delete OAuth/OIDC App","operationId":"3c-4-delete-oauth-oidc-app","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"OAuth app <uuid>, not <app-uuid>","example":"14c4f897-3d8a-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/openid/{appUUID}/get-cert":{"get":{"tags":["Applications"],"summary":"3C.5 Get OAuth Certificate","operationId":"3c-5-get-oauth-certificate","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"OAuth app UUID","example":"06b353eb-3d8b-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/openid/{appUuid}/endpoints":{"get":{"tags":["Applications"],"summary":"3C.6 Get OAuth App Endpoints","operationId":"3c-6-get-oauth-app-endpoints","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"OAuth app UUID","example":"06b353eb-3d8b-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Returns authorization, token, userinfo, and other endpoints for this OAuth app.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/openid/reset/client-id":{"get":{"tags":["Applications"],"summary":"3C.7 Generate New Client ID","operationId":"3c-7-generate-new-client-id","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Regenerates the client_id for an OAuth app. Pass appUuid as query param.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/openid/reset/client-secret":{"get":{"tags":["Applications"],"summary":"3C.8 Generate New Client Secret","operationId":"3c-8-generate-new-client-secret","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Regenerates the client_secret for an OAuth app.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/jwt":{"post":{"tags":["Applications"],"summary":"3D.1 Create JWT App","operationId":"3d-1-create-jwt-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idpApplicationsName":{"type":"string","description":""},"appName":{"type":"string","description":""},"appDescription":{"type":"string","description":""},"redirectUrls":{"type":"string","description":""},"logoutUrl":{"type":"string","description":""},"expiryTime":{"type":"integer","description":""},"clientId":{"type":"string","description":""},"clientSecret":{"type":"string","description":""},"algo":{"type":"string","description":""},"subject":{"type":"string","description":""},"subjectAttributeValue":{"type":"string","description":""},"sloEnabled":{"type":"string","description":""},"forceAuthn":{"type":"string","description":""},"showOnEnduserDashboard":{"type":"string","description":""},"isCustomerIdpEnabled":{"type":"string","description":""},"isUserMapping":{"type":"string","description":""},"updateCustomerDuringSso":{"type":"string","description":""},"isMultivaluedAttributesEnabled":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"jwtRequestParameters":{"type":"string","description":""},"identitySource":{"type":"string","description":""},"attributeMappings":{"type":"string","description":""}}},"example":{"idpApplicationsName":"JWT App","appName":"My JWT App","appDescription":"Description of my JWT app","redirectUrls":["https://myapp.example.com/callback"],"logoutUrl":"https://myapp.example.com/logout","expiryTime":60,"clientId":null,"clientSecret":null,"algo":"RSA-SHA256","subject":"EMAIL","subjectAttributeValue":null,"sloEnabled":false,"forceAuthn":false,"showOnEnduserDashboard":true,"isCustomerIdpEnabled":false,"isUserMapping":false,"updateCustomerDuringSso":false,"isMultivaluedAttributesEnabled":false,"isSharedAccount":false,"jwtRequestParameters":"param1;param2","identitySource":null,"attributeMappings":[{"attributeName":"email","attributeType":"MINIORANGE","attributeValue":"EMAIL"},{"attributeName":"firstName","attributeType":"MINIORANGE","attributeValue":"FIRST_NAME"},{"attributeName":"lastName","attributeType":"MINIORANGE","attributeValue":"LAST_NAME"}]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/jwt/{appUUID}":{"get":{"tags":["Applications"],"summary":"3D.2 Get JWT App","operationId":"3d-2-get-jwt-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"JWT app <uuid> , not <app-uuid>","example":"4a39e60e-3d8c-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3D.3 Update JWT App","operationId":"3d-3-update-jwt-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"JWT app <uuid> , not <app-uuid>","example":"4a39e60e-3d8c-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idpApplicationsName":{"type":"string","description":""},"appName":{"type":"string","description":""},"appDescription":{"type":"string","description":""},"redirectUrls":{"type":"string","description":""},"logoutUrl":{"type":"string","description":""},"expiryTime":{"type":"integer","description":""},"clientId":{"type":"string","description":""},"clientSecret":{"type":"string","description":""},"algo":{"type":"string","description":""},"subject":{"type":"string","description":""},"subjectAttributeValue":{"type":"string","description":""},"sloEnabled":{"type":"string","description":""},"forceAuthn":{"type":"string","description":""},"showOnEnduserDashboard":{"type":"string","description":""},"isCustomerIdpEnabled":{"type":"string","description":""},"isUserMapping":{"type":"string","description":""},"updateCustomerDuringSso":{"type":"string","description":""},"isMultivaluedAttributesEnabled":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"jwtRequestParameters":{"type":"string","description":""},"identitySource":{"type":"string","description":""},"attributeMappings":{"type":"string","description":""}}},"example":{"idpApplicationsName":"JWT App","appName":"My JWT App Updated","appDescription":"Updated description","redirectUrls":["https://myapp.example.com/callback","https://myapp.example.com/v2/callback"],"logoutUrl":"https://myapp.example.com/logout","expiryTime":120,"clientId":null,"clientSecret":null,"algo":"RSA-SHA256","subject":"EMAIL","subjectAttributeValue":null,"sloEnabled":false,"forceAuthn":false,"showOnEnduserDashboard":true,"isCustomerIdpEnabled":false,"isUserMapping":false,"updateCustomerDuringSso":false,"isMultivaluedAttributesEnabled":false,"isSharedAccount":false,"jwtRequestParameters":"param1;param2","identitySource":null,"attributeMappings":[{"attributeName":"email","attributeType":"MINIORANGE","attributeValue":"EMAIL"},{"attributeName":"firstName","attributeType":"MINIORANGE","attributeValue":"FIRST_NAME"}]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3D.4 Delete JWT App","operationId":"3d-4-delete-jwt-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"JWT app <uuid> , not <app-uuid>","example":"4a39e60e-3d8c-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/jwt/{appUUID}/get-cert":{"get":{"tags":["Applications"],"summary":"3D.5 Get JWT Certificate","operationId":"3d-5-get-jwt-certificate","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"JWT app <uuid> , not <app-uuid>","example":"c5207423-3d8c-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/pwd_less":{"post":{"tags":["Applications"],"summary":"3E.1 Create Passwordless App","operationId":"3e-1-create-passwordless-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"appName":{"type":"string","description":""},"redirectUrl":{"type":"string","description":""},"description":{"type":"string","description":""},"applicationName":{"type":"string","description":""},"logoPath":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""}}},"example":{"appName":"My Passwordless App","redirectUrl":"https://app.example.com/dashboard","description":"Passwordless login for my app","applicationName":"Passwordless","logoPath":"images/solution-logos/customapp.png","showOnEndUserDashboard":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/pwd_less/{uuid}":{"get":{"tags":["Applications"],"summary":"3E.2 Get Passwordless App","operationId":"3e-2-get-passwordless-app","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Passwordless app UUID (not app-uuid)","example":"93a73e36-3db2-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3E.3 Update Passwordless App","operationId":"3e-3-update-passwordless-app","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Passwordless app UUID","example":"93a73e36-3db2-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"appName":{"type":"string","description":""},"redirectUrl":{"type":"string","description":""},"description":{"type":"string","description":""},"applicationName":{"type":"string","description":""},"logoPath":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""}}},"example":{"appName":"My Passwordless App Updated","redirectUrl":"https://app.example.com/v2/dashboard","description":"Updated description","applicationName":"Passwordless","logoPath":"images/solution-logos/customapp.png","showOnEndUserDashboard":false}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3E.4 Delete Passwordless App","operationId":"3e-4-delete-passwordless-app","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Passwordless app UUID","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/ext_sso":{"post":{"tags":["Applications"],"summary":"3F.1 Create Browser Extension App","operationId":"3f-1-create-browser-extension-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customAppName":{"type":"string","description":""},"appName":{"type":"string","description":""},"appType":{"type":"string","description":""},"ssoUrl":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""}}},"example":{"customAppName":"My Browser Extension App","appName":"Add Custom App","appType":"EXT_SSO","ssoUrl":"https://app.example.com/login","isSharedAccount":false,"showOnEndUserDashboard":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/ext_sso/{appUUID}":{"get":{"tags":["Applications"],"summary":"3F.2 Get Browser Extension App","operationId":"3f-2-get-browser-extension-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Browser extension app UUID","example":"<appUUID>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3F.3 Update Browser Extension App","operationId":"3f-3-update-browser-extension-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Browser extension app UUID","example":"<appUUID>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customAppName":{"type":"string","description":""},"appName":{"type":"string","description":""},"ssoUrl":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""}}},"example":{"customAppName":"My Browser Extension App","appName":"My Browser Extension App","ssoUrl":"https://app.example.com/login","isSharedAccount":false,"showOnEndUserDashboard":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3F.4 Delete Browser Extension App","operationId":"3f-4-delete-browser-extension-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Browser extension app UUID","example":"<appUUID>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/form_post":{"post":{"tags":["Applications"],"summary":"3F.5 Create Form Post App","operationId":"3f-5-create-form-post-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customAppName":{"type":"string","description":""},"appName":{"type":"string","description":""},"ssoUrl":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""}}},"example":{"customAppName":"My Form Post App","appName":"My Form Post App","ssoUrl":"https://app.example.com/login","isSharedAccount":false,"showOnEndUserDashboard":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/form_post/{appUUID}":{"get":{"tags":["Applications"],"summary":"3F.6 Get Form Post App","operationId":"3f-6-get-form-post-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Form post app UUID","example":"<appUUID>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3F.7 Update Form Post App","operationId":"3f-7-update-form-post-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Form post app UUID","example":"<appUUID>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customAppName":{"type":"string","description":""},"appName":{"type":"string","description":""},"ssoUrl":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""}}},"example":{"customAppName":"My Form Post App","appName":"My Form Post App","ssoUrl":"https://app.example.com/login","isSharedAccount":false,"showOnEndUserDashboard":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3F.8 Delete Form Post App","operationId":"3f-8-delete-form-post-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Form post app UUID","example":"<appUUID>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/ext_sso/custom":{"post":{"tags":["Applications"],"summary":"3F.9 Create Custom Browser Extension App","operationId":"3f-9-create-custom-browser-extension-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customAppName":{"type":"string","description":""},"appName":{"type":"string","description":""},"ssoUrl":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""}}},"example":{"customAppName":"My Custom Ext App","appName":"My Custom Ext App","ssoUrl":"https://custom.example.com","isSharedAccount":false,"showOnEndUserDashboard":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/ext_sso/custom/{appId}":{"put":{"tags":["Applications"],"summary":"3F.10 Update Custom Browser Extension App","operationId":"3f-10-update-custom-browser-extension-app","parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-id>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customAppName":{"type":"string","description":""},"appName":{"type":"string","description":""},"ssoUrl":{"type":"string","description":""},"isSharedAccount":{"type":"string","description":""},"showOnEndUserDashboard":{"type":"string","description":""}}},"example":{"customAppName":"My Custom Ext App Updated","appName":"My Custom Ext App Updated","ssoUrl":"https://custom.example.com","isSharedAccount":false,"showOnEndUserDashboard":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3F.11 Delete Custom Browser Extension App","operationId":"3f-11-delete-custom-browser-extension-app","parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-id>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/radius":{"post":{"tags":["Applications"],"summary":"3G.1 Create RADIUS App","operationId":"3g-1-create-radius-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"clientName":{"type":"string","description":""},"clientIp":{"type":"string","description":""},"sharedSecret":{"type":"string","description":""},"doNotSupportChallenge":{"type":"string","description":""},"sendAttributes":{"type":"string","description":""},"isAccountingAuditEnabled":{"type":"string","description":""},"allowChangePassword":{"type":"string","description":""},"forceMessageAuthenticator":{"type":"string","description":""},"auditInvalidUsers":{"type":"string","description":""},"allowedMethods":{"type":"string","description":""},"radiusAttributeMapping":{"type":"string","description":""}}},"example":{"clientName":"My RADIUS Appp","clientIp":"192.168.1.100","sharedSecret":"my-shared-secret","doNotSupportChallenge":false,"sendAttributes":false,"isAccountingAuditEnabled":false,"allowChangePassword":false,"forceMessageAuthenticator":false,"auditInvalidUsers":false,"allowedMethods":["PAP"],"radiusAttributeMapping":[]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/radius/{appUUID}":{"get":{"tags":["Applications"],"summary":"3G.2 Get RADIUS App","operationId":"3g-2-get-radius-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"RADIUS app <uuid>, not <app-uuid>","example":"9d3d490e-3db5-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3G.3 Update RADIUS App","operationId":"3g-3-update-radius-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"RADIUS app UUID","example":"9d3d490e-3db5-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"applicationName":{"type":"string","description":""},"clientName":{"type":"string","description":""},"clientIp":{"type":"string","description":""},"sharedSecret":{"type":"string","description":""},"doNotSupportChallenge":{"type":"string","description":""},"sendAttributes":{"type":"string","description":""},"isAccountingAuditEnabled":{"type":"string","description":""},"allowChangePassword":{"type":"string","description":""},"forceMessageAuthenticator":{"type":"string","description":""},"auditInvalidUsers":{"type":"string","description":""},"allowedMethods":{"type":"string","description":""},"defaultEapMethod":{"type":"string","description":""},"groupDelimiter":{"type":"string","description":""},"identitySource":{"type":"string","description":""},"radiusAttributeMapping":{"type":"string","description":""}}},"example":{"applicationName":"AWS Workspaces","clientName":"My RADIUS App","clientIp":"192.168.1.100","sharedSecret":"my-shared-secret","doNotSupportChallenge":false,"sendAttributes":false,"isAccountingAuditEnabled":false,"allowChangePassword":false,"forceMessageAuthenticator":false,"auditInvalidUsers":false,"allowedMethods":["PAP"],"defaultEapMethod":null,"groupDelimiter":null,"identitySource":null,"radiusAttributeMapping":[]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3G.4 Delete RADIUS App","operationId":"3g-4-delete-radius-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"RADIUS app <uuid> , not <app-uuid>","example":"9d3d490e-3db5-11f1-a1ca-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/radius/attributes":{"get":{"tags":["Applications"],"summary":"3G.5 Get RADIUS App Attributes","operationId":"3g-5-get-radius-app-attributes","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Returns available RADIUS attributes for configuration.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/radius/certificate":{"get":{"tags":["Applications"],"summary":"3G.6 Download RADIUS Certificate","operationId":"3g-6-download-radius-certificate","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Downloads the RADIUS certificate file.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/api":{"post":{"tags":["Applications"],"summary":"3H.1 Create Desktop App","operationId":"3h-1-create-desktop-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"applicationName":{"type":"string","description":""},"clientName":{"type":"string","description":""},"appDescription":{"type":"string","description":""},"appSecret":{"type":"string","description":""}}},"example":{"applicationName":"API","clientName":"My Desktop Appp","appDescription":"Desktop/API access app for my service","appSecret":"my-super-secret-key-here"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/api/{appUUID}":{"get":{"tags":["Applications"],"summary":"3H.2 Get Desktop App","operationId":"3h-2-get-desktop-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Desktop app <uuid> , not <app-uuid>","example":"36d4363f-3e0d-11f1-9e19-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3H.3 Update Desktop App","operationId":"3h-3-update-desktop-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Desktop app <uuid>, not <app-uuid>","example":"36d4363f-3e0d-11f1-9e19-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"applicationName":{"type":"string","description":""},"clientName":{"type":"string","description":""},"appDescription":{"type":"string","description":""},"appSecret":{"type":"string","description":""}}},"example":{"applicationName":"API","clientName":"My Desktop App Updated","appDescription":"Updated description","appSecret":"my-new-secret-key-here"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3H.4 Delete Desktop App","operationId":"3h-4-delete-desktop-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Desktop app <uuid> , not <app-uuid>","example":"36d4363f-3e0d-11f1-9e19-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/tacacs":{"post":{"tags":["Applications"],"summary":"3I.1 Create TACACS App","operationId":"3i-1-create-tacacs-app","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"applicationName":{"type":"string","description":""},"clientName":{"type":"string","description":""},"clientIp":{"type":"string","description":""},"sharedSecret":{"type":"string","description":""},"sendPrivilege":{"type":"string","description":""},"sendGroups":{"type":"string","description":""},"doNotSupportChallenge":{"type":"string","description":""},"isAccountingAuditEnabled":{"type":"string","description":""},"maxRequestsAllowedCount":{"type":"string","description":""},"vendor":{"type":"string","description":""},"identitySource":{"type":"string","description":""},"idpPolicy":{"type":"string","description":""}}},"example":{"applicationName":"Custom TACACS Client","clientName":"My TACACS App","clientIp":["192.168.1.100"],"sharedSecret":"my-tacacs-shared-secret","sendPrivilege":false,"sendGroups":false,"doNotSupportChallenge":false,"isAccountingAuditEnabled":false,"maxRequestsAllowedCount":null,"vendor":null,"identitySource":null,"idpPolicy":[]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/tacacs/{appUUID}":{"get":{"tags":["Applications"],"summary":"3I.2 Get TACACS App","operationId":"3i-2-get-tacacs-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"TACACS app <uuid> , not <app-uuid>","example":"2ef665f4-3e0e-11f1-9e19-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Applications"],"summary":"3I.3 Update TACACS App","operationId":"3i-3-update-tacacs-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"TACACS app <uuid> , not <app-uuid>","example":"2ef665f4-3e0e-11f1-9e19-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"applicationName":{"type":"string","description":""},"clientName":{"type":"string","description":""},"clientIp":{"type":"string","description":""},"sharedSecret":{"type":"string","description":""},"sendPrivilege":{"type":"string","description":""},"sendGroups":{"type":"string","description":""},"doNotSupportChallenge":{"type":"string","description":""},"isAccountingAuditEnabled":{"type":"string","description":""},"maxRequestsAllowedCount":{"type":"string","description":""},"vendor":{"type":"string","description":""},"identitySource":{"type":"string","description":""},"idpPolicy":{"type":"string","description":""}}},"example":{"applicationName":"Custom TACACS Client","clientName":"My TACACS App Updated","clientIp":["192.168.1.200"],"sharedSecret":"new-tacacs-secret","sendPrivilege":true,"sendGroups":false,"doNotSupportChallenge":false,"isAccountingAuditEnabled":true,"maxRequestsAllowedCount":null,"vendor":{"vendorName":"Default","uuid":"40faf721-4451-4145-ad48-12fcb3caecde"},"identitySource":null,"idpPolicy":[]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Applications"],"summary":"3I.4 Delete TACACS App","operationId":"3i-4-delete-tacacs-app","parameters":[{"name":"appUUID","in":"path","required":true,"schema":{"type":"string"},"description":"TACACS app <uuid> , not <app-uuid>","example":"2ef665f4-3e0e-11f1-9e19-4ebecb2f8197"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/authen-policies":{"get":{"tags":["Authentication Policies"],"summary":"4.1 List Policies (paginated)","operationId":"4-1-list-policies-paginated","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"example":"10"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Authentication Policies"],"summary":"4.3 Create Policy","operationId":"4-3-create-policy","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string","description":""},"group":{"type":"string","description":""},"policyName":{"type":"string","description":""},"firstFactorAuthType":{"type":"string","description":""},"isSecondFactorMandatory":{"type":"string","description":""},"secondFactorAuthType":{"type":"string","description":""},"enableRbaDevice":{"type":"string","description":""},"enableRbaLocation":{"type":"string","description":""},"enableRbaTimeOfAccess":{"type":"string","description":""},"enableRbaIP":{"type":"string","description":""},"force_2faOnLogin":{"type":"string","description":""},"isEndUserSecondFactorEnabled":{"type":"string","description":""},"checkDeviceId":{"type":"string","description":""},"adaptivePolicy":{"type":"string","description":""}}},"example":{"app":{"id":"9e5c1142-6587-11f1-81c8-92e868ed51b9","name":"My Desktop App"},"group":{"id":"249065cc-9892-4f57-8d42-2aa1ea00a250","name":"Engigneering"},"policyName":"Default Policy","firstFactorAuthType":"PASSWORD","isSecondFactorMandatory":false,"secondFactorAuthType":null,"enableRbaDevice":false,"enableRbaLocation":false,"enableRbaTimeOfAccess":false,"enableRbaIP":false,"force_2faOnLogin":false,"isEndUserSecondFactorEnabled":false,"checkDeviceId":false,"adaptivePolicy":null}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/authen-policies/{policyUuid}":{"get":{"tags":["Authentication Policies"],"summary":"4.2 Get Policy by UUID","operationId":"4-2-get-policy-by-uuid","parameters":[{"name":"policyUuid","in":"path","required":true,"schema":{"type":"string"},"description":"<policy-uuid>","example":"b2292dad-c05d-11f0-ae3a-94bb4356a5e3"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Authentication Policies"],"summary":"4.4 Update Policy","operationId":"4-4-update-policy","parameters":[{"name":"policyUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<policy-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string","description":""},"group":{"type":"string","description":""},"policyName":{"type":"string","description":""},"firstFactorAuthType":{"type":"string","description":""},"isSecondFactorMandatory":{"type":"string","description":""},"secondFactorAuthType":{"type":"string","description":""},"enableRbaDevice":{"type":"string","description":""},"enableRbaLocation":{"type":"string","description":""},"enableRbaTimeOfAccess":{"type":"string","description":""},"enableRbaIP":{"type":"string","description":""},"force_2faOnLogin":{"type":"string","description":""},"isEndUserSecondFactorEnabled":{"type":"string","description":""},"checkDeviceId":{"type":"string","description":""},"adaptivePolicy":{"type":"string","description":""}}},"example":{"app":{"id":"9e5c1142-6587-11f1-81c8-92e868ed51b9","name":"My Desktop App"},"group":{"id":"f9adddf9-435a-4512-901c-5e04d371cc27","name":"g1"},"policyName":"Admin MFA Policy Updated","firstFactorAuthType":"PASSWORD","isSecondFactorMandatory":true,"secondFactorAuthType":"PUSH NOTIFICATIONS","enableRbaDevice":false,"enableRbaLocation":false,"enableRbaTimeOfAccess":false,"enableRbaIP":false,"force_2faOnLogin":true,"isEndUserSecondFactorEnabled":true,"checkDeviceId":false,"adaptivePolicy":null}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Authentication Policies"],"summary":"4.5 Delete Policy","operationId":"4-5-delete-policy","parameters":[{"name":"policyUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<policy-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/authen-policies/bulk":{"post":{"tags":["Authentication Policies"],"summary":"4.6 Create Policies in Bulk","operationId":"4-6-create-policies-in-bulk","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":"[\n  {\n    \"app\": { \"id\": \"9e5c1142-6587-11f1-81c8-92e868ed51b9\", \"name\": \"My Desktop App\" },\n    \"group\": { \"id\": \"f9adddf9-435a-4512-901c-5e04d371cc27\", \"name\": \"g1\" },\n    \"policyName\": \"Admin Policy\",\n    \"firstFactorAuthType\": \"PASSWORD\",\n    \"isSecondFactorMandatory\": true,\n    \"secondFactorAuthType\": \"EMAIL\",\n    \"force_2faOnLogin\": true,\n    \"checkDeviceId\": false,\n    \"adaptivePolicy\": null\n//   },\n//   {\n//     \"app\": { \"id\": \"<app-uuid>\", \"name\": \"My App\" },\n//     \"group\": { \"id\": \"<group-uuid-2>\", \"name\": \"End Users\" },\n//     \"policyName\": \"End User Policy\",\n//     \"firstFactorAuthType\": \"PASSWORD\",\n//     \"isSecondFactorMandatory\": false,\n//     \"secondFactorAuthType\": null,\n//     \"force_2faOnLogin\": false,\n//     \"checkDeviceId\": false,\n//     \"adaptivePolicy\": null\n  }\n]"}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/authen-policies/bulk/{appUuid}":{"put":{"tags":["Authentication Policies"],"summary":"4.7 Update Policies in Bulk (for an App)","operationId":"4-7-update-policies-in-bulk-for-an-app","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"<uuid>, not <app-uuid>","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":[{"app":{"id":"9e5c1142-6587-11f1-81c8-92e868ed51b9","name":"My Desktop App"},"group":{"id":"f9adddf9-435a-4512-901c-5e04d371cc27","name":"g1"},"policyName":"Admin Policy Updated","firstFactorAuthType":"PASSWORD","isSecondFactorMandatory":true,"secondFactorAuthType":"PUSH NOTIFICATIONS","force_2faOnLogin":true,"checkDeviceId":true,"adaptivePolicy":null}]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/app-policy/{appUuid}":{"get":{"tags":["App Access Policy"],"summary":"5.1 Get App Policy by App UUID","operationId":"5-1-get-app-policy-by-app-uuid","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["App Access Policy"],"summary":"5.2 Delete App Policy by App UUID","operationId":"5-2-delete-app-policy-by-app-uuid","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/app-policy/groups/{appUuid}":{"get":{"tags":["App Access Policy"],"summary":"5.3 Get Group IDs for App Policy","operationId":"5-3-get-group-ids-for-app-policy","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/idps":{"get":{"tags":["Identity Providers (IDPs)"],"summary":"6.1 List Configured IDPs","operationId":"6-1-list-configured-idps","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/idps/pre-config":{"get":{"tags":["Identity Providers (IDPs)"],"summary":"6.7 Get Pre-configured IDP by Type (detail)","operationId":"6-7-get-pre-configured-idp-by-type-detail-2","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/idps/setDefault":{"patch":{"tags":["Identity Providers (IDPs)"],"summary":"6.3 Set Default IDP","operationId":"6-3-set-default-idp","parameters":[{"name":"uuid","in":"query","required":false,"schema":{"type":"string"},"description":"UUID of the IDP to set as default","example":"<idp-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Sets the specified IDP as the default. Pass uuid as a query param. If uuid is omitted, resets to no default IDP.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/idps/show":{"patch":{"tags":["Identity Providers (IDPs)"],"summary":"6.4 Toggle IDP Visibility to Users","operationId":"6-4-toggle-idp-visibility-to-users","parameters":[{"name":"uuid","in":"query","required":false,"schema":{"type":"string"},"description":"UUID of the IDP to toggle visibility","example":"<idp-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Toggles whether the IDP is visible on the end-user login page. Pass uuid as a query param.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/idps/{uuid}":{"delete":{"tags":["Identity Providers (IDPs)"],"summary":"6.5 Delete IDP","operationId":"6-5-delete-idp","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<idp-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/idps/valid-fallback-idps":{"get":{"tags":["Identity Providers (IDPs)"],"summary":"6.6 Get Valid Fallback IDPs","operationId":"6-6-get-valid-fallback-idps","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/ldap":{"get":{"tags":["LDAP Directories"],"summary":"7.1 List LDAP Directories","operationId":"7-1-list-ldap-directories","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["LDAP Directories"],"summary":"7.3 Create LDAP Directory","operationId":"7-3-create-ldap-directory","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":""},"identifier":{"type":"string","description":""},"domainMapping":{"type":"string","description":""},"showIdpToUsers":{"type":"string","description":""},"endUserLogin":{"type":"string","description":""},"isDefault":{"type":"string","description":""},"connection":{"type":"string","description":""},"userAttributes":{"type":"string","description":""},"authentication":{"type":"string","description":""}}},"example":{"displayName":"Corporate LDAP","identifier":"corporate_ldap","domainMapping":"","showIdpToUsers":false,"endUserLogin":true,"isDefault":false,"connection":{"urlPrefix":"ldap://","gatewayUrl":"ldap.example.com:389","gatewayHost":"miniorange","isGatewayInstalled":false,"dirType":"Active Directory","bindAccDn":"cn=admin,dc=example,dc=com","bindAccPass":"secret","searchBase":"dc=example,dc=com","searchFilter":"(objectClass=person)","allowChangePassword":false,"authenticateAdminFromLdap":false},"userAttributes":{"usernameAttribute":"uid","emailAttribute":"mail","firstNameAttribute":"givenName","lastNameAttribute":"sn","isSendConfiguredAttributes":false,"attributeMapping":[]},"authentication":{"isActivated":true,"showIdpToUsers":false,"isFallbackEnabled":false,"syncUserInMiniorange":false,"authenticateAdminFromLdap":false}}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/ldap/{uuid}":{"get":{"tags":["LDAP Directories"],"summary":"7.2 Get LDAP Directory by UUID","operationId":"7-2-get-ldap-directory-by-uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["LDAP Directories"],"summary":"7.4 Update LDAP Directory","operationId":"7-4-update-ldap-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"14ebc220-59ba-11f1-8b59-a604e67300e4"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":""},"identifier":{"type":"string","description":""},"domainMapping":{"type":"string","description":""},"showIdpToUsers":{"type":"string","description":""},"endUserLogin":{"type":"string","description":""},"isDefault":{"type":"string","description":""},"connection":{"type":"string","description":""},"userAttributes":{"type":"string","description":""},"authentication":{"type":"string","description":""}}},"example":{"displayName":"Corporate LDAP","identifier":"corporate_ldap","domainMapping":"","showIdpToUsers":false,"endUserLogin":true,"isDefault":false,"connection":{"urlPrefix":"ldap://","gatewayUrl":"ldap.example.com:389","gatewayHost":"miniorange","isGatewayInstalled":false,"dirType":"Active Directory","bindAccDn":"cn=admin,dc=example,dc=com","bindAccPass":"secret","searchBase":"dc=example,dc=com","searchFilter":"(objectClass=person)","allowChangePassword":false,"authenticateAdminFromLdap":false},"userAttributes":{"usernameAttribute":"uid","emailAttribute":"mail","firstNameAttribute":"givenName","lastNameAttribute":"sn","isSendConfiguredAttributes":false,"attributeMapping":[]},"authentication":{"isActivated":true,"showIdpToUsers":false,"isFallbackEnabled":false,"syncUserInMiniorange":false,"authenticateAdminFromLdap":false}}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["LDAP Directories"],"summary":"7.5 Delete LDAP Directory","operationId":"7-5-delete-ldap-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/ldap/default-filters":{"get":{"tags":["LDAP Directories"],"summary":"7.6 Get Default LDAP Search Filters","operationId":"7-6-get-default-ldap-search-filters","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/ldap/provisioning/{uuid}":{"post":{"tags":["LDAP Directories"],"summary":"7.7 Save LDAP Provisioning Config","operationId":"7-7-save-ldap-provisioning-config","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isImportUserEnabled":{"type":"string","description":""},"isImportGroupEnabled":{"type":"string","description":""},"isAssignUsersToGroupEnabled":{"type":"string","description":""},"isCreateUserEnabled":{"type":"string","description":""},"isEditUserEnabled":{"type":"string","description":""},"isDeleteUserEnabled":{"type":"string","description":""},"isPasswordSyncEnabled":{"type":"string","description":""},"isCreateGroupEnabled":{"type":"string","description":""},"isDeleteGroupEnabled":{"type":"string","description":""},"isNestedImportGroupEnabled":{"type":"string","description":""},"provisioningAttrsMappings":{"type":"string","description":""}}},"example":{"isImportUserEnabled":true,"isImportGroupEnabled":true,"isAssignUsersToGroupEnabled":true,"isCreateUserEnabled":false,"isEditUserEnabled":false,"isDeleteUserEnabled":false,"isPasswordSyncEnabled":false,"isCreateGroupEnabled":false,"isDeleteGroupEnabled":false,"isNestedImportGroupEnabled":false,"provisioningAttrsMappings":[{"attributeType":"STANDARD_ATTRIBUTE","attributeName":"mail","attributeValue":"primaryEmail"},{"attributeType":"STANDARD_ATTRIBUTE","attributeName":"givenName","attributeValue":"fname"},{"attributeType":"STANDARD_ATTRIBUTE","attributeName":"sn","attributeValue":"lname"},{"attributeType":"STANDARD_ATTRIBUTE","attributeName":"samaccountname","attributeValue":"username"}]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/ldap/ping/server":{"post":{"tags":["LDAP Directories"],"summary":"7.8 Test LDAP Server Credentials","operationId":"7-8-test-ldap-server-credentials","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"gatewayConfiguration":{"type":"string","description":""}}},"example":{"gatewayConfiguration":{"ldapServer":"ldap://13.233.37.113","bindAccountDN":"pranchal@mustang.in","bindAccountPassword":"Passw0rd."}}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/ldap/ping":{"get":{"tags":["LDAP Directories"],"summary":"7.9 Ping LDAP Server URL","operationId":"7-9-ping-ldap-server-url","parameters":[{"name":"url","in":"query","required":false,"schema":{"type":"string"},"description":"Full LDAP server URL to ping, e.g. ldap://192.168.1.100:389 or ldaps://ldap.example.com:636","example":"ldap://ldap.example.com:389"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/database/{uuid}":{"get":{"tags":["External DB Directories"],"summary":"8.1 Get External DB Directory","operationId":"8-1-get-external-db-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["External DB Directories"],"summary":"8.3 Update External DB Directory","operationId":"8-3-update-external-db-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"directoryName":{"type":"string","description":""},"host":{"type":"string","description":""},"port":{"type":"integer","description":""},"database":{"type":"string","description":""},"username":{"type":"string","description":""},"password":{"type":"string","description":""}}},"example":{"directoryName":"My DB Directory Updated","host":"db2.example.com","port":3306,"database":"users_db","username":"dbuser","password":"dbpass"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["External DB Directories"],"summary":"8.4 Delete External DB Directory","operationId":"8-4-delete-external-db-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/database":{"post":{"tags":["External DB Directories"],"summary":"8.2 Create External DB Directory","operationId":"8-2-create-external-db-directory","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles":{"get":{"tags":["Roles & Capabilities"],"summary":"9.1 List Custom Roles","operationId":"9-1-list-custom-roles","parameters":[{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"example":"10"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Roles & Capabilities"],"summary":"9.2 Create Custom Role","operationId":"9-2-create-custom-role","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roleName":{"type":"string","description":""},"adminCapabilities":{"type":"string","description":""},"endUserCapabilities":{"type":"string","description":""},"customCapabilities":{"type":"string","description":""}}},"example":{"roleName":"My Custom Admin Role","adminCapabilities":{"user_manage_view":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"user_manage_view","isAllowed":true,"titleText":"View Users"},"user_manage_add":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"user_manage_add","isAllowed":true,"titleText":"Add Users"},"user_manage_edit":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"user_manage_edit","isAllowed":true,"titleText":"Edit Users"},"user_manage_delete":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"user_manage_delete","isAllowed":false,"titleText":"Delete Users"},"user_manage_admindelete":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"user_manage_admindelete","isAllowed":false,"titleText":"Delete other Admins"},"user_manage_disableEnable":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"user_manage_disableEnable","isAllowed":true,"titleText":"Disable/Enable Users"},"user_manage_role":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"user_manage_role","isAllowed":true,"titleText":"Manage User Roles"},"user_manage_activeSession":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"user_manage_activeSession","isAllowed":true,"titleText":"Manage User Active Sessions"},"user_impersonation":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"user_impersonation","isAllowed":false,"titleText":"Impersonate users"},"group_manage_view":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"group_manage_view","isAllowed":true,"titleText":"View Groups"},"group_manage_add":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"group_manage_add","isAllowed":true,"titleText":"Add Groups"},"group_manage_edit":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"group_manage_edit","isAllowed":true,"titleText":"Edit Groups"},"group_manage_delete":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"group_manage_delete","isAllowed":false,"titleText":"Delete Groups"},"group_manage_assign":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"group_manage_assign","isAllowed":true,"titleText":"Assign/Deassign Users to/from a group"},"apps_manage_view":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"apps_manage_view","isAllowed":true,"titleText":"View Application"},"apps_manage_add":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"apps_manage_add","isAllowed":true,"titleText":"Add Application"},"apps_manage_edit":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"apps_manage_edit","isAllowed":true,"titleText":"Edit Application"},"apps_manage_delete":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"apps_manage_delete","isAllowed":false,"titleText":"Delete Application"},"policies_app":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"policies_app","isAllowed":true,"titleText":"Manage App Policies"},"report_view_auditReport":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"report_view_auditReport","isAllowed":true,"titleText":"Audit Report"},"report_view_userLogin":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"report_view_userLogin","isAllowed":true,"titleText":"User Login Report"},"mfa_setup_customer":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"mfa_setup_customer","isAllowed":true,"titleText":"Setup Two Factor"},"mfa_setup_options":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"mfa_setup_options","isAllowed":true,"titleText":"Manage 2FA options for Enduser"},"authsource_idp_view":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"authsource_idp_view","isAllowed":true,"titleText":"View Identity Providers"},"authsource_store_view":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"authsource_store_view","isAllowed":true,"titleText":"View External Directories"},"provisioning_manage":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"provisioning_manage","isAllowed":true,"titleText":"Manage User Provisioning"},"branding_edit":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"branding_edit","isAllowed":false,"titleText":"Edit Branding Settings"},"miscellaneous_dashboard":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"miscellaneous_dashboard","isAllowed":true,"titleText":"Dashboard Access"},"miscellaneous_settings_product":{"isDefault":"CUSTOMER_SUPER_ADMIN","userCapability":"miscellaneous_settings_product","isAllowed":true,"titleText":"Show Product Settings"}},"endUserCapabilities":{"dashboard_access":{"isDefault":"END_USER","userCapability":"dashboard_access","isAllowed":true,"titleText":"Dashboard Access"},"setup_two_factor":{"isDefault":"END_USER","userCapability":"setup_two_factor","isAllowed":true,"titleText":"Setup Two Factor"},"access_profile_page":{"isDefault":"END_USER","userCapability":"access_profile_page","isAllowed":true,"titleText":"Allow Access to User's Profile Page"},"app_section_access":{"isDefault":"END_USER","userCapability":"app_section_access","isAllowed":false,"titleText":"Access to App Section"},"allow_users_to_change_password":{"isDefault":"END_USER","userCapability":"allow_users_to_change_password","isAllowed":true,"titleText":"Allow users to change the password"},"allow_users_to_change_email":{"isDefault":"END_USER","userCapability":"allow_users_to_change_primary_mail","isAllowed":true,"titleText":"Allow users to change the Email"}},"customCapabilities":{"my_custom_capability_1":{"isDefault":"CUSTOM","userCapability":"my_custom_capability_1","isAllowed":true,"titleText":"My Custom Feature Access","category":"Custom","description":"Allows access to my custom feature"}}}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/{roleUUID}":{"put":{"tags":["Roles & Capabilities"],"summary":"9.3 Update Custom Role","operationId":"9-3-update-custom-role","parameters":[{"name":"roleUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<role-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roleName":{"type":"string","description":""},"description":{"type":"string","description":""}}},"example":{"roleName":"HelpDesk Updated","description":"Updated description"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/{uuid}":{"delete":{"tags":["Roles & Capabilities"],"summary":"9.4 Delete Custom Role","operationId":"9-4-delete-custom-role","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<role-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/{roleUUID}/capabilities":{"get":{"tags":["Roles & Capabilities"],"summary":"9.5 Get Role Capabilities","operationId":"9-5-get-role-capabilities","parameters":[{"name":"roleUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<role-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Roles & Capabilities"],"summary":"9.14 Delete Capability from Role","operationId":"9-14-delete-capability-from-role","parameters":[{"name":"roleUUID","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<role-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"capabilityKeys":{"type":"string","description":""}}},"example":{"capabilityKeys":["MANAGE_USERS","MANAGE_GROUPS"]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/{uuid}/users":{"get":{"tags":["Roles & Capabilities"],"summary":"9.6 Get Users in Custom Role","operationId":"9-6-get-users-in-custom-role","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/{uuid}/available-users":{"get":{"tags":["Roles & Capabilities"],"summary":"9.7 Get Users NOT in Custom Role","operationId":"9-7-get-users-not-in-custom-role","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/{uuid}/assign":{"post":{"tags":["Roles & Capabilities"],"summary":"9.8 Assign Users to Custom Role","operationId":"9-8-assign-users-to-custom-role","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Custom role UUID","example":"<role-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"Body is a plain JSON array of user UUIDs (not an object). Controller: UserRolesController.assignUsersToRole","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":["<user-guid>"]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/{uuid}/reset":{"post":{"tags":["Roles & Capabilities"],"summary":"9.9 Reset (Remove) Users from Custom Role","operationId":"9-9-reset-remove-users-from-custom-role","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Custom role UUID","example":"<role-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":["<user-guid>"]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/users":{"get":{"tags":["Roles & Capabilities"],"summary":"9.10 Get Users in Default Role","operationId":"9-10-get-users-in-default-role","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/available-users":{"get":{"tags":["Roles & Capabilities"],"summary":"9.11 Get Users NOT in Default Role","operationId":"9-11-get-users-not-in-default-role","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/assign":{"post":{"tags":["Roles & Capabilities"],"summary":"9.12 Assign Users to Default Role","operationId":"9-12-assign-users-to-default-role","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userUuids":{"type":"string","description":""}}},"example":{"userUuids":["<user-uuid-1>"]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/reset":{"post":{"tags":["Roles & Capabilities"],"summary":"9.13 Reset Users from Default Role","operationId":"9-13-reset-users-from-default-role","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userUuids":{"type":"string","description":""}}},"example":{"userUuids":["<user-uuid-1>"]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/default/{defaultRoleName}/capabilities":{"get":{"tags":["Roles & Capabilities"],"summary":"9.15 Get Default Role Capabilities","operationId":"9-15-get-default-role-capabilities","parameters":[{"name":"defaultRoleName","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<default-role-name>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/roles/default/{defaultRoleName}":{"put":{"tags":["Roles & Capabilities"],"summary":"9.16 Update Default Role","operationId":"9-16-update-default-role","parameters":[{"name":"defaultRoleName","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<default-role-name>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":""}}},"example":{"displayName":"Updated Role Name"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/password-policy":{"get":{"tags":["Password Policy"],"summary":"10.1 Get Password Policy","operationId":"10-1-get-password-policy","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Password Policy"],"summary":"10.2 Save / Update Password Policy","operationId":"10-2-save-update-password-policy","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"minLength":{"type":"integer","description":""},"maxLength":{"type":"integer","description":""},"passwordExpiryDays":{"type":"integer","description":""},"trackLastNPasswords":{"type":"integer","description":""},"allowedSymbols":{"type":"string","description":""},"requireLowercase":{"type":"string","description":""},"requireUppercase":{"type":"string","description":""},"requireNumbers":{"type":"string","description":""},"requireSymbols":{"type":"string","description":""},"restrictUsername":{"type":"string","description":""},"restrictFname":{"type":"string","description":""},"restrictLname":{"type":"string","description":""},"restrictEmail":{"type":"string","description":""},"forceUsersToChangePassword":{"type":"string","description":""},"maxSameCharsAllowed":{"type":"integer","description":""},"notifyAfterBlock":{"type":"string","description":""},"unlockUsingReset":{"type":"string","description":""},"noOfAttempts":{"type":"integer","description":""},"timeToDisable":{"type":"integer","description":""}}},"example":{"minLength":8,"maxLength":15,"passwordExpiryDays":90,"trackLastNPasswords":5,"allowedSymbols":"!@#$.%^&*-_","requireLowercase":true,"requireUppercase":true,"requireNumbers":true,"requireSymbols":true,"restrictUsername":false,"restrictFname":false,"restrictLname":false,"restrictEmail":false,"forceUsersToChangePassword":true,"maxSameCharsAllowed":2,"notifyAfterBlock":false,"unlockUsingReset":false,"noOfAttempts":3,"timeToDisable":30}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/password-policy/{guid}":{"delete":{"tags":["Password Policy"],"summary":"10.3 Delete Password Policy","operationId":"10-3-delete-password-policy","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<policy-guid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/mfa/alternate-methods":{"get":{"tags":["MFA Configuration"],"summary":"12.1 Get Forgot Phone / Alternate MFA Methods Config","operationId":"12-1-get-forgot-phone-alternate-mfa-methods-config","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["MFA Configuration"],"summary":"12.2 Update Forgot Phone / Alternate MFA Methods Config","operationId":"12-2-update-forgot-phone-alternate-mfa-methods-config","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enableAlternateMethod":{"type":"string","description":""},"methods":{"type":"string","description":""}}},"example":{"enableAlternateMethod":true,"methods":["EMAIL","SMS"]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/mfa/methods":{"get":{"tags":["MFA Configuration"],"summary":"12.3 Get 2FA End-User Config (allowed methods)","operationId":"12-3-get-2fa-end-user-config-allowed-methods","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["MFA Configuration"],"summary":"12.4 Update 2FA End-User Methods","operationId":"12-4-update-2fa-end-user-methods","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabledMethods":{"type":"string","description":""},"defaultMethod":{"type":"string","description":""},"allowUserToChoose":{"type":"string","description":""}}},"example":{"enabledMethods":["GOOGLE AUTHENTICATOR","PUSH NOTIFICATIONS","EMAIL","SMS"],"defaultMethod":"EMAIL","allowUserToChoose":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/hardware-token":{"get":{"tags":["Hardware Tokens"],"summary":"13.1 List Hardware Tokens","operationId":"13-1-list-hardware-tokens","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Hardware Tokens"],"summary":"13.3 Create Hardware Token","operationId":"13-3-create-hardware-token","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tokenSerialNumber":{"type":"string","description":""},"tokenSecretKey":{"type":"string","description":""},"tokenType":{"type":"string","description":""},"tokenOffset":{"type":"integer","description":""}}},"example":{"tokenSerialNumber":"HW-TOKEN-0013","tokenSecretKey":"base32secrethere","tokenType":"TOTP","tokenOffset":30}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/hardware-token/users":{"get":{"tags":["Hardware Tokens"],"summary":"13.2 List User-Hardware Token Assignments","operationId":"13-2-list-user-hardware-token-assignments","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/hardware-token/assign":{"post":{"tags":["Hardware Tokens"],"summary":"13.4 Assign Hardware Tokens to Users","operationId":"13-4-assign-hardware-tokens-to-users","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uuIds":{"type":"string","description":""},"tokenIds":{"type":"string","description":""}}},"example":{"uuIds":["3e0c074d-8716-4481-992a-daecbac64c14"],"tokenIds":["HW-TOKEN-001"]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/hardware-token/de-assign":{"post":{"tags":["Hardware Tokens"],"summary":"13.5 De-assign Hardware Tokens from Users","operationId":"13-5-de-assign-hardware-tokens-from-users","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":[{"primaryEmail":"enduser1@xecurify.com","hardwareTokenId":"HW-TOKEN-001"}]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/hardware-token/delete":{"post":{"tags":["Hardware Tokens"],"summary":"13.6 Delete Hardware Tokens","operationId":"13-6-delete-hardware-tokens","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":["HW-TOKEN-001","HW-TOKEN-002"]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/attributes":{"get":{"tags":["Custom Attributes"],"summary":"14.1 Get Custom Attributes","operationId":"14-1-get-custom-attributes","parameters":[{"name":"mappingType","in":"query","required":false,"schema":{"type":"string"},"example":"USER_PROFILE"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Custom Attributes"],"summary":"14.2 Save / Create Attributes","operationId":"14-2-save-create-attributes","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mappingType":{"type":"string","description":""},"attributes":{"type":"string","description":""}}},"example":{"mappingType":"USER_PROFILE","attributes":[{"key":"department","label":"Department","type":"textfield","isRequired":"false","showOnUserProfilePage":"true"}]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Custom Attributes"],"summary":"14.3 Update Single Attribute","operationId":"14-3-update-single-attribute","parameters":[{"name":"key","in":"query","required":false,"schema":{"type":"string"},"example":"customAttribute2"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":""},"isMandatory":{"type":"string","description":""}}},"example":{"displayName":"Department Updated","isMandatory":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Custom Attributes"],"summary":"14.4 Delete Attributes","operationId":"14-4-delete-attributes","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mappingType":{"type":"string","description":""},"keys":{"type":"string","description":""}}},"example":{"mappingType":"USER_PROFILE","keys":["department"]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/attributes/i18n":{"post":{"tags":["Custom Attributes"],"summary":"14.5 Save i18n for Attribute (multi-language)","operationId":"14-5-save-i18n-for-attribute-multi-language","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fr":{"type":"string","description":""}}},"example":{"fr":{"label":"Departement","optionsText":""}}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/attributes/i18n/{languageCode}":{"post":{"tags":["Custom Attributes"],"summary":"14.6 Save Language for Multiple Attributes","operationId":"14-6-save-language-for-multiple-attributes","parameters":[{"name":"languageCode","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<language-code>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"department":{"type":"string","description":""},"costCenter":{"type":"string","description":""}}},"example":{"department":"Département","costCenter":"Centre de coûts"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/codes/{guid}":{"get":{"tags":["Security Codes"],"summary":"15.1 Get Security Codes for User","operationId":"15-1-get-security-codes-for-user","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<guid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Security Codes"],"summary":"15.2 Delete Security Codes for User","operationId":"15-2-delete-security-codes-for-user","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<guid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/aliases":{"get":{"tags":["Login Alias Config"],"summary":"16.1 Get Alias Config","operationId":"16-1-get-alias-config","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Login Alias Config"],"summary":"16.2 Add / Update Alias Config","operationId":"16-2-add-update-alias-config","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/aws-cognito":{"get":{"tags":["AWS Cognito Directories"],"summary":"17.1 List AWS Cognito Directories","operationId":"17-1-list-aws-cognito-directories","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["AWS Cognito Directories"],"summary":"17.3 Create AWS Cognito Directory","operationId":"17-3-create-aws-cognito-directory","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"directoryName":{"type":"string","description":""},"region":{"type":"string","description":""},"userPoolId":{"type":"string","description":""},"clientId":{"type":"string","description":""},"clientSecret":{"type":"string","description":""}}},"example":{"directoryName":"My Cognito Pool","region":"us-east-1","userPoolId":"us-east-1_XXXXXXXXX","clientId":"<cognito-client-id>","clientSecret":"<cognito-client-secret>"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/aws-cognito/{uuid}":{"get":{"tags":["AWS Cognito Directories"],"summary":"17.2 Get AWS Cognito Directory","operationId":"17-2-get-aws-cognito-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["AWS Cognito Directories"],"summary":"17.4 Update AWS Cognito Directory","operationId":"17-4-update-aws-cognito-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"directoryName":{"type":"string","description":""},"region":{"type":"string","description":""},"userPoolId":{"type":"string","description":""},"clientId":{"type":"string","description":""},"clientSecret":{"type":"string","description":""}}},"example":{"directoryName":"My Cognito Pool Updated","region":"us-east-1","userPoolId":"us-east-1_XXXXXXXXX","clientId":"<cognito-client-id>","clientSecret":"<cognito-client-secret>"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["AWS Cognito Directories"],"summary":"17.5 Delete AWS Cognito Directory","operationId":"17-5-delete-aws-cognito-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/web3/{uuid}":{"get":{"tags":["Web3 Directories"],"summary":"18.1 Get Web3 Directory","operationId":"18-1-get-web3-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Web3 Directories"],"summary":"18.4 Update Web3 Directory","operationId":"18-4-update-web3-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"directoryName":{"type":"string","description":""},"walletType":{"type":"string","description":""},"networkId":{"type":"string","description":""}}},"example":{"directoryName":"My Web3 Directory Updated","walletType":"METAMASK","networkId":"1"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Web3 Directories"],"summary":"18.5 Delete Web3 Directory","operationId":"18-5-delete-web3-directory","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/web3/wallet-types":{"get":{"tags":["Web3 Directories"],"summary":"18.2 Get Wallet Types","operationId":"18-2-get-wallet-types","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/idps/v1/web3":{"post":{"tags":["Web3 Directories"],"summary":"18.3 Create Web3 Directory","operationId":"18-3-create-web3-directory","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":""},"identifier":{"type":"string","description":""},"walletType":{"type":"string","description":""},"showIdpToUsers":{"type":"string","description":""},"endUserLogin":{"type":"string","description":""},"promptForUserRegistration":{"type":"string","description":""},"sendConfiguredAttributes":{"type":"string","description":""},"isDefault":{"type":"string","description":""},"domainMapping":{"type":"string","description":""},"attributeMapping":{"type":"string","description":""},"groupMapping":{"type":"string","description":""}}},"example":{"displayName":"My Metamask Web3 Directory","identifier":"my_metamask_web3","walletType":"metamask","showIdpToUsers":false,"endUserLogin":false,"promptForUserRegistration":false,"sendConfiguredAttributes":false,"isDefault":false,"domainMapping":null,"attributeMapping":[{"incomingAttribute":"wallet_address","outgoingAttribute":"username"}],"groupMapping":[]}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/admin/app/authorization/{appUuid}":{"get":{"tags":["Provisioning"],"summary":"19A.1 Get App Authorization Config","operationId":"19a-1-get-app-authorization-config","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Provisioning"],"summary":"19A.3 Create App Authorization","operationId":"19a-3-create-app-authorization","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"authType":{"type":"string","description":""},"clientId":{"type":"string","description":""},"clientSecret":{"type":"string","description":""},"tenantId":{"type":"string","description":""}}},"example":{"authType":"OAUTH2","clientId":"<client-id>","clientSecret":"<client-secret>","tenantId":"<tenant-id>"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"put":{"tags":["Provisioning"],"summary":"19A.4 Update App Authorization","operationId":"19a-4-update-app-authorization","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"authType":{"type":"string","description":""},"clientId":{"type":"string","description":""},"clientSecret":{"type":"string","description":""},"tenantId":{"type":"string","description":""}}},"example":{"authType":"OAUTH2","clientId":"<client-id>","clientSecret":"<client-secret>","tenantId":"<tenant-id>"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/admin/app/authorization/{appUuid}/valid":{"get":{"tags":["Provisioning"],"summary":"19A.2 Check if App Auth is Valid","operationId":"19a-2-check-if-app-auth-is-valid","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/admin/app/authorization/token/{authorizationUuid}":{"get":{"tags":["Provisioning"],"summary":"19A.5 Get Auth Token","operationId":"19a-5-get-auth-token","parameters":[{"name":"authorizationUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<authorizationUuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/admin/app/authorization/{appUuid}/{oauthAppConfigType}":{"post":{"tags":["Provisioning"],"summary":"19A.6 Create Authorization by Type","operationId":"19a-6-create-authorization-by-type","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"},{"name":"oauthAppConfigType","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<oauth-config-type>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"clientId":{"type":"string","description":""},"clientSecret":{"type":"string","description":""}}},"example":{"clientId":"<client-id>","clientSecret":"<client-secret>"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/admin/app/app-meta/{appUuid}":{"get":{"tags":["Provisioning"],"summary":"19B.1 Get App Meta Schema","operationId":"19b-1-get-app-meta-schema","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/admin/app/attributes/{appUuid}":{"get":{"tags":["Provisioning"],"summary":"19B.2 Get App Attributes","operationId":"19b-2-get-app-attributes","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/admin/app/default-attribute-mapping/{appUuid}":{"get":{"tags":["Provisioning"],"summary":"19B.3 Get Default Attribute Mapping","operationId":"19b-3-get-default-attribute-mapping","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/admin/app/provisioning-options/{appUuid}":{"get":{"tags":["Provisioning"],"summary":"19B.4 Get Provisioning Options Fields Schema","operationId":"19b-4-get-provisioning-options-fields-schema","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/admin/app/authorization-fields/{appUuid}":{"get":{"tags":["Provisioning"],"summary":"19B.5 Get Authorization Fields Schema","operationId":"19b-5-get-authorization-fields-schema","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/v1/office365/subscriptions":{"get":{"tags":["Provisioning"],"summary":"19C.1 Get Office365 Subscriptions","operationId":"19c-1-get-office365-subscriptions","parameters":[{"name":"appUuid","in":"query","required":false,"schema":{"type":"string"},"description":"REQUIRED - UUID of the Office365 provisioning app","example":"<app-uuid>"},{"name":"fetchFromMS","in":"query","required":false,"schema":{"type":"string"},"description":"Optional - re-fetch from Microsoft (default false)","example":"false"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/v1/office365/services":{"get":{"tags":["Provisioning"],"summary":"19C.2 Get Services for Subscription","operationId":"19c-2-get-services-for-subscription","parameters":[{"name":"productId","in":"query","required":false,"schema":{"type":"string"},"description":"REQUIRED - subscription product UUID","example":"<office365-product-id>"},{"name":"appUuid","in":"query","required":false,"schema":{"type":"string"},"description":"REQUIRED - Office365 provisioning app UUID","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/v1/office365/license/assignees":{"get":{"tags":["Provisioning"],"summary":"19C.3 Get License Assignees","operationId":"19c-3-get-license-assignees","parameters":[{"name":"assignee_type","in":"query","required":false,"schema":{"type":"string"},"description":"REQUIRED - USER or GROUP","example":"USER"},{"name":"product_id","in":"query","required":false,"schema":{"type":"string"},"description":"REQUIRED - subscription product UUID","example":"<office365-product-id>"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"REQUIRED - max 100","example":"25"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"Optional - pagination offset (default 0)","example":"0"},{"name":"searchText","in":"query","required":false,"schema":{"type":"string"},"description":"Optional - search filter (default empty)"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/v1/office365/{appUuid}/users/{assigneeId}/licenses/{productId}":{"get":{"tags":["Provisioning"],"summary":"19C.4 Get User's Licenses","operationId":"19c-4-get-user-s-licenses","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"},{"name":"assigneeId","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<assignee-id>"},{"name":"productId","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<product-id>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/v1/office365/{appUuid}/groups/{assigneeId}/licenses/{productId}":{"get":{"tags":["Provisioning"],"summary":"19C.5 Get Group's Licenses","operationId":"19c-5-get-group-s-licenses","parameters":[{"name":"appUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"},{"name":"assigneeId","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<assignee-id>"},{"name":"productId","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<product-id>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/office365refetchdomains/{tenantId}/{authConfigUuid}":{"get":{"tags":["Provisioning"],"summary":"19C.7 Re-fetch Office365 Domains","operationId":"19c-7-re-fetch-office365-domains","parameters":[{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"},"description":"Microsoft 365 tenant ID (GUID)","example":"<microsoft-tenant-id>"},{"name":"authConfigUuid","in":"path","required":true,"schema":{"type":"string"},"description":"Auth config UUID for the Office365 app","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/v1/app-associated-users":{"get":{"tags":["Provisioning"],"summary":"19D.1 Get Users Associated to Provisioning App","operationId":"19d-1-get-users-associated-to-provisioning-app","parameters":[{"name":"appUuid","in":"query","required":false,"schema":{"type":"string"},"description":"REQUIRED - provisioning app UUID","example":"<app-uuid>"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"Optional - pagination offset","example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Optional - page size","example":"25"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/provisioning/v1/app-associated-groups":{"get":{"tags":["Provisioning"],"summary":"19D.2 Get Groups Associated to Provisioning App","operationId":"19d-2-get-groups-associated-to-provisioning-app","parameters":[{"name":"appUuid","in":"query","required":false,"schema":{"type":"string"},"description":"REQUIRED - provisioning app UUID","example":"<app-uuid>"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"Optional - pagination offset","example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Optional - page size","example":"25"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/tacacs/vendors":{"get":{"tags":["TACACS Vendors"],"summary":"20.1 List TACACS Vendors","operationId":"20-1-list-tacacs-vendors","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["TACACS Vendors"],"summary":"20.2 Create TACACS Vendor","operationId":"20-2-create-tacacs-vendor","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"vendorName":{"type":"string","description":""},"vendorId":{"type":"integer","description":""},"description":{"type":"string","description":""}}},"example":{"vendorName":"Cisco","vendorId":9,"description":"Cisco vendor for TACACS"}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/apps/{app_uuid}/permissions":{"get":{"tags":["App Permissions"],"summary":"21.1 Get App Permissions","operationId":"21-1-get-app-permissions","parameters":[{"name":"app_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"c8d7d819-c148-11f0-87d4-0242ac13000a"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["App Permissions"],"summary":"21.2 Add App Permissions (bulk)","operationId":"21-2-add-app-permissions-bulk","parameters":[{"name":"app_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"c8d7d819-c148-11f0-87d4-0242ac13000a"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":[{"key":"read:users","description":"Read user profiles"},{"key":"write:users","description":"Modify user profiles"},{"key":"delete:users","description":"Delete user accounts"},{"key":"read:groups","description":"Read group information"},{"key":"write:groups","description":"Create and modify groups"}]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/apps/{app_uuid}/permissions/upsert":{"post":{"tags":["App Permissions"],"summary":"21.3 Upsert App Permissions (bulk)","operationId":"21-3-upsert-app-permissions-bulk","parameters":[{"name":"app_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"c8d7d819-c148-11f0-87d4-0242ac13000a"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":[{"name":"read:users","description":"Read user profiles"}]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/users/basic-details":{"get":{"tags":["User Dashboard Details"],"summary":"22.1 Get User Basic Details","operationId":"22-1-get-user-basic-details","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/users/details":{"get":{"tags":["User Dashboard Details"],"summary":"22.2 Get User Full Details","operationId":"22-2-get-user-full-details","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/users/capabilities":{"get":{"tags":["User Dashboard Details"],"summary":"22.3 Get User Capabilities","operationId":"22-3-get-user-capabilities","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/users/custom-attribute/mappings":{"get":{"tags":["User Dashboard Details"],"summary":"22.4 Get Custom Attribute Mappings","operationId":"22-4-get-custom-attribute-mappings","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/users/branding-preferences":{"get":{"tags":["User Dashboard Details"],"summary":"22.5 Get Branding Preferences","operationId":"22-5-get-branding-preferences","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/delivery/v1/admin/configure/smtp":{"get":{"tags":["Delivery (SMTP)"],"summary":"23.1 Get SMTP preferences","operationId":"23-1-get-smtp-preferences","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Delivery (SMTP)"],"summary":"23.2 Save SMTP preferences","operationId":"23-2-save-smtp-preferences","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"useDefault":{"type":"string","description":""},"senderEmail":{"type":"string","description":""},"senderName":{"type":"string","description":""},"primary":{"type":"string","description":""},"secondary":{"type":"string","description":""}}},"example":{"useDefault":false,"senderEmail":"noreply@example.com","senderName":"Example Org","primary":{"hostName":"smtp.example.com","portNo":587,"username":"smtp-user","password":"<smtp-password>","encryptionType":"TLS","authorizationType":"basicOAuth"},"secondary":{"hostName":"smtp-fallback.example.com","portNo":25,"username":"smtp-fallback-user","password":"<fallback-password>","encryptionType":"SSL","authorizationType":"basicOAuth"}}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Delivery (SMTP)"],"summary":"23.3 Delete SMTP preferences","operationId":"23-3-delete-smtp-preferences","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/{guid}/aliases":{"get":{"tags":["Bulk & Import APIs"],"summary":"24.1 Get User Username Aliases","operationId":"24-1-get-user-username-aliases","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<user-guid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-directory-service — `UsernameAliasesController`. Lists username aliases for one user.","security":[{"CustomerKey":[],"TargetCustomer":[]}]},"post":{"tags":["Bulk & Import APIs"],"summary":"24.2 Add Username Aliases (single user)","operationId":"24-2-add-username-aliases-single-user","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<user-guid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-directory-service — bulk add/update aliases for one user (`List<UsernameAliasAddRequest>`). Requires alias config UUID from folder 16.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":[{"aliasConfigUuid":"2eebd583-c63c-444f-a5eb-913aabaab171","alias":"badge123"}]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/aliases/bulk":{"post":{"tags":["Bulk & Import APIs"],"summary":"24.3 Bulk Add/Update Username Aliases (multiple users)","operationId":"24-3-bulk-add-update-username-aliases-multiple-users","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-directory-service — `POST /v1/admin/users/aliases/bulk` for multiple users in one call.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":[{"endUserPrimaryEmail":"enduser1@xecurify.com","aliases":[{"aliasConfigUuid":"2eebd583-c63c-444f-a5eb-913aabaab171","alias":"badge123"}]}]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/import":{"post":{"tags":["Bulk & Import APIs"],"summary":"24.4 Import Users / Groups (async)","operationId":"24-4-import-users-groups-async","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-apps-service — `ImportRequest`. Triggers async user and/or group import from provisioned app. Set `uuid` to target-tenant app UUID. `customerKey` must match delegated tenant (`{{target_customer_id}}`).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerKey":{"type":"string","description":""},"uuid":{"type":"string","description":""},"importUsers":{"type":"string","description":""},"importGroups":{"type":"string","description":""}}},"example":{"customerKey":"<target-customer-id>","uuid":"c8d7d819-c148-11f0-87d4-0242ac13000a","importUsers":true,"importGroups":false}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/import/sync-usergroup-assignments":{"post":{"tags":["Bulk & Import APIs"],"summary":"24.5 Import User–Group Assignments Sync (async)","operationId":"24-5-import-user-group-assignments-sync-async","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-apps-service — async sync of user–group assignments from directory source app.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerKey":{"type":"string","description":""},"uuid":{"type":"string","description":""},"importUsers":{"type":"string","description":""},"importGroups":{"type":"string","description":""}}},"example":{"customerKey":"<target-customer-id>","uuid":"c8d7d819-c148-11f0-87d4-0242ac13000a","importUsers":false,"importGroups":false}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/import/roles":{"post":{"tags":["Bulk & Import APIs"],"summary":"24.6 Import Roles (async)","operationId":"24-6-import-roles-async","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-apps-service — `ImportRolesAndPermissionsRequest`. Both `importRoles` and `importPermissions` are required (non-null); handler always triggers role import event.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerKey":{"type":"string","description":""},"uuid":{"type":"string","description":""},"importRoles":{"type":"string","description":""},"importPermissions":{"type":"string","description":""}}},"example":{"customerKey":"<target-customer-id>","uuid":"c8d7d819-c148-11f0-87d4-0242ac13000a","importRoles":true,"importPermissions":false}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/import/permissions":{"post":{"tags":["Bulk & Import APIs"],"summary":"24.7 Import Permissions (async)","operationId":"24-7-import-permissions-async","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-apps-service — `ImportRolesAndPermissionsRequest`. Both flags required non-null; handler always triggers permission import event.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerKey":{"type":"string","description":""},"uuid":{"type":"string","description":""},"importRoles":{"type":"string","description":""},"importPermissions":{"type":"string","description":""}}},"example":{"customerKey":"<target-customer-id>","uuid":"c8d7d819-c148-11f0-87d4-0242ac13000a","importRoles":false,"importPermissions":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/import/roles-permissions-assignments":{"post":{"tags":["Bulk & Import APIs"],"summary":"24.8 Import Role–Permission Assignments (async)","operationId":"24-8-import-role-permission-assignments-async","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-apps-service — `ImportRolesAndPermissionsRequest`. Both flags required non-null; handler always triggers role-permission assignment import.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerKey":{"type":"string","description":""},"uuid":{"type":"string","description":""},"importRoles":{"type":"string","description":""},"importPermissions":{"type":"string","description":""}}},"example":{"customerKey":"<target-customer-id>","uuid":"c8d7d819-c148-11f0-87d4-0242ac13000a","importRoles":true,"importPermissions":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/import/password-policy":{"post":{"tags":["Bulk & Import APIs"],"summary":"24.9 Import Password Policy (async)","operationId":"24-9-import-password-policy-async","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-apps-service — `ImportPasswordPolicyRequest`. `customerKey` in body must match Customer-Key header (target tenant after delegation). `importPasswordPolicy` must be true to trigger the event.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerKey":{"type":"string","description":""},"uuid":{"type":"string","description":""},"importPasswordPolicy":{"type":"string","description":""}}},"example":{"customerKey":"<target-customer-id>","uuid":"c8d7d819-c148-11f0-87d4-0242ac13000a","importPasswordPolicy":true}}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/apps/v1/apps/{app_uuid}/permissions/import":{"post":{"tags":["Bulk & Import APIs"],"summary":"24.10 Import App Permissions from CSV","operationId":"24-10-import-app-permissions-from-csv","parameters":[{"name":"app_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter","example":"<app-uuid>"}],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"description":"idp-apps-service — multipart CSV import. Each line: `permissionKey,label` (label becomes description). Attach a `.csv` file in Postman Body → form-data → file.","security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/branding-preferences/%7Bdomain%7D":{"get":{"tags":["MultiBranding"],"summary":"Get Brand Preferences by custom domain","operationId":"get-brand-preferences-by-custom-domain","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/branding-preferences/brands":{"get":{"tags":["MultiBranding"],"summary":"Get Branding Prefs by customer Id and Brand Name","operationId":"get-branding-prefs-by-customer-id-and-brand-name","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}},"/services/api/directory/v1/admin/users/duplicates":{"get":{"tags":["Delete Duplicate EndUser"],"summary":"26.1 - Get Duplicate EndUser's","operationId":"26-1-get-duplicate-enduser-s","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]},"delete":{"tags":["Delete Duplicate EndUser"],"summary":"26.2 - Delete Duplicate EndUser's","operationId":"26-2-delete-duplicate-enduser-s","parameters":[],"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"},"example":["72dd0ea3-cbc7-4eb1-8333-befa75e5f41c","72dd0ea3-cbc7-4eb1-8333-befa75e5f452"]}}},"security":[{"CustomerKey":[],"TargetCustomer":[]}]}}},"components":{"securitySchemes":{"CustomerKey":{"type":"apiKey","in":"header","name":"Customer-Key","description":"Super Admin ID or customer key"},"TargetCustomer":{"type":"apiKey","in":"header","name":"X-Target-Customer-Id","description":"Target customer tenant the Super Admin is acting on"}}}}