# Locai IAM Service Docs ## Docs - [Accept user invite with email and verification code](https://iam-docs.platform.ai71services.ai/api-reference/authentication/accept-user-invite-with-email-and-verification-code.md): Accept user invite with email and verification code - [Create User By Email and Password](https://iam-docs.platform.ai71services.ai/api-reference/authentication/create-user-by-email-and-password.md): Create User By Email and Password - [Generate Access Token for Machine User](https://iam-docs.platform.ai71services.ai/api-reference/authentication/generate-access-token-for-machine-user.md): Generate Access Token for Machine User for non interactive flows - [Get user information by token](https://iam-docs.platform.ai71services.ai/api-reference/authentication/get-user-information-by-token.md): Get user information by token, for human user - [Get user information by user id](https://iam-docs.platform.ai71services.ai/api-reference/authentication/get-user-information-by-user-id.md): Get user information by user Id - [Get User JWKs](https://iam-docs.platform.ai71services.ai/api-reference/authentication/get-user-jwks.md): Get User JWKs - [Get User Manager Roles by token](https://iam-docs.platform.ai71services.ai/api-reference/authentication/get-user-manager-roles-by-token.md): Show all the management roles user has in organizations Roles Allowed: ** SESSION_OWNER (User to whom the session belongs) - [Get user organizations by email](https://iam-docs.platform.ai71services.ai/api-reference/authentication/get-user-organizations-by-email.md): Get user organizations by email - [Request password reset code by email](https://iam-docs.platform.ai71services.ai/api-reference/authentication/request-password-reset-code-by-email.md): Request password reset code on behalf of user - [Request to send email verification code](https://iam-docs.platform.ai71services.ai/api-reference/authentication/request-to-send-email-verification-code.md): Request to send email verification code to verify user email - [Sign In By Email and Password](https://iam-docs.platform.ai71services.ai/api-reference/authentication/sign-in-by-email-and-password.md): Sign in By Email and Password - [Sign Out user by sessionId](https://iam-docs.platform.ai71services.ai/api-reference/authentication/sign-out-user-by-sessionid.md): Sign Out user by sessionId - [Update user information](https://iam-docs.platform.ai71services.ai/api-reference/authentication/update-user-information.md): Update user information like firstname, lastname and phone by user Id - [Update User Password using current password](https://iam-docs.platform.ai71services.ai/api-reference/authentication/update-user-password-using-current-password.md): Update User Password by using current password - [Update user password using email and verification code](https://iam-docs.platform.ai71services.ai/api-reference/authentication/update-user-password-using-email-and-verification-code.md): Update user password using email and verification code - [Verify user email](https://iam-docs.platform.ai71services.ai/api-reference/authentication/verify-user-email.md): Verify user email by Verification code - [Activate inactive user from organization group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/activate-inactive-user-from-organization-group.md): Reactivates a user from the organizations group. - [Add Identity Provider for Google](https://iam-docs.platform.ai71services.ai/api-reference/authorization/add-identity-provider-for-google.md): Add Identity Provider for Google Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Add Identity Provider for Microsoft AzureAD](https://iam-docs.platform.ai71services.ai/api-reference/authorization/add-identity-provider-for-microsoft-azuread.md): Add Identity Provider for Microsoft AzureAD Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Add LDAP Identity Provider and link to Organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/add-ldap-identity-provider-and-link-to-organization.md): Add LDAP Identity Provider and link to Organization Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Add / Update Organization Custom Settings](https://iam-docs.platform.ai71services.ai/api-reference/authorization/add-update-organization-custom-settings.md): Add or updates the organization custom settings Roles Allowed: ** SUPER_ADMIN - [Add user to org](https://iam-docs.platform.ai71services.ai/api-reference/authorization/add-user-to-org.md): Add user to org Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_OWNER ** ORG_USER_MANAGER - [Add/Update Group Users Roles](https://iam-docs.platform.ai71services.ai/api-reference/authorization/addupdate-group-users-roles.md): Add or Update Roles for the users part of the group * Replace Existing Roles: When the roles parameter is provided in the API request, it replaces all the current roles assigned to the user with the new set of roles specified in the request. * Partial Updates Not Suppo… - [Add/Update pre-defined application roles](https://iam-docs.platform.ai71services.ai/api-reference/authorization/addupdate-pre-defined-application-roles.md): Add or Update roles to application to be available as pre-defined roles to all organizations Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Add/Update Roles and Permissions of organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/addupdate-roles-and-permissions-of-organization.md): Add/Update Roles and Permissions of organization Note: Permissions for the existing roles that are not included in the request will be removed. Roles Allowed: ** SUPER_ADMIN ** ORG_OWNER ** GENERIC_MACHINE_USER - [Add/Update Roles and Permissions of organization group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/addupdate-roles-and-permissions-of-organization-group.md): Add/Update Roles and Permissions of organization group Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_ADMIN - [Advanced User Search](https://iam-docs.platform.ai71services.ai/api-reference/authorization/advanced-user-search.md): Searches list of users in the app with advance parameters The search operation is exclusive and applies AND logic between parameters. This means that if multiple parameters are provided (e.g., name, email), only users that match all specified criteria will be returned. - [Check Permissions of User](https://iam-docs.platform.ai71services.ai/api-reference/authorization/check-permissions-of-user.md): Check Permissions of User for input actions Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Create User](https://iam-docs.platform.ai71services.ai/api-reference/authorization/create-user.md): Create User - [Creates a Machine/ Service User](https://iam-docs.platform.ai71services.ai/api-reference/authorization/creates-a-machine-service-user.md): Creates a Machine/ Service User for non interactive flows Roles Allowed: ** SUPER_ADMIN - [Delete Group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/delete-group.md): Deletes Group from the organization. Roles Allowed: ** SUPER_ADMIN ** ORG_ADMIN ** GENERIC_MACHINE_USER - [Delete Identity Provider](https://iam-docs.platform.ai71services.ai/api-reference/authorization/delete-identity-provider.md): Delete Identity Provider Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Delete pre-defined application roles](https://iam-docs.platform.ai71services.ai/api-reference/authorization/delete-pre-defined-application-roles.md): Deletes pre-defined application roles Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Delete privileged member from organization group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/delete-privileged-member-from-organization-group.md): Deletes a privileged member from the organizations group for example Group Admin. Roles Allowed: ** SUPER_ADMIN ** ORG_ADMIN ** GENERIC_MACHINE_USER - [Delete roles from the group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/delete-roles-from-the-group.md): Deletes roles available in the organization group. Roles Allowed: ** SUPER_ADMIN ** ORG_ADMIN ** GENERIC_MACHINE_USER ** GROUP_ADMIN - [Delete User](https://iam-docs.platform.ai71services.ai/api-reference/authorization/delete-user.md): Delete User Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Delete user from org](https://iam-docs.platform.ai71services.ai/api-reference/authorization/delete-user-from-org.md): Delete user from org Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_OWNER ** ORG_USER_MANAGER - [Delete User from organization group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/delete-user-from-organization-group.md): Deletes a user from the organizations group. Passing the deactivate flag as true will deactivate the user instead of deleting them. - [Extend existing Session](https://iam-docs.platform.ai71services.ai/api-reference/authorization/extend-existing-session.md): Extends the existing active session Roles Allowed: ** SESSION OWNER (User to whom the session belongs) - [Get All Organizations](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-all-organizations.md): Get All Organizations Please note that passing the additional query params like includeMetadata, includeMembers etc. adds up to latency Therefore use them only if required Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Get all users](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-all-users.md): Provides list of users in the app Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Get All Users of an organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-all-users-of-an-organization.md): Get All Users of an organization Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_OWNER ** ORG_USER_MANAGER - [Get All Users of an organization group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-all-users-of-an-organization-group.md): Get All Users of an organization group The search operation is exclusive and applies AND logic between query parameters. This means that if multiple parameters are provided (e.g., name, email), only users that match all specified criteria will be returned. Roles Allo… - [Get all users with advance parameters](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-all-users-with-advance-parameters.md): Provides list of users in the app based on the advanced parameters passed Please be mindful that this endpoint adds up the latency and should be used with caution. Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Get Organization Data](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-organization-data.md): Get Organization Data Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_OWNER - [Get Organization Events](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-organization-events.md): Get Organization Events Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_OWNER ** ORG_USER_MANAGER - [Get Organization Identity Providers List](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-organization-identity-providers-list.md): Get Organization Identity Providers List Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Get organization login settings](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-organization-login-settings.md): Get organization login settings Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_OWNER - [Get pre-defined application roles](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-pre-defined-application-roles.md): Get a list of pre-defined roles to application to be available as pre-defined roles to all organizations Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Get privileged member from organization group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-privileged-member-from-organization-group.md): Provides a list of privileged member from the organizations group for example Group Admin. Roles Allowed: ** SUPER_ADMIN ** ORG_ADMIN ** GENERIC_MACHINE_USER - [Get User Roles by user id](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-user-roles-by-user-id.md): Get User Roles by user id - [Get User Roles for logged in user](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-user-roles-for-logged-in-user.md): Get User Roles for logged in user - [Get User Sessions of an organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-user-sessions-of-an-organization.md): Active and Expired Sessions of User part of the given organization Roles Allowed: ** ORG_OWNER Note: if the session was not revoked/terminated before its expiration, it will be part of the list with expirationDate key in the response - [Get User's Groups in an Organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/get-users-groups-in-an-organization.md): Provides a list of groups to which user belongs Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_ADMIN ** SESSION_OWNER // User calling the API - [Invite Group Admin in organization group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/invite-group-admin-in-organization-group.md): Invite Group Admin in organization group Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_ADMIN - [Invite Org Admin in organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/invite-org-admin-in-organization.md): Invite user managers in organization Roles Allowed: ** SUPER_ADMIN ** ORG_ADMIN - [Invite Org User managers in organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/invite-org-user-managers-in-organization.md): Invite user managers in organization Roles Allowed: ** SUPER_ADMIN ** ORG_ADMIN - [Invite User in organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/invite-user-in-organization.md): Invite User in organization with custom roles Roles Allowed: ** SUPER_ADMIN ** ORG_ADMIN ** ORG_USER_MANAGER ** GENERIC_MACHINE_USER - [Invite User in organization group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/invite-user-in-organization-group.md): Invite User in organization groups with custom roles. Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_ADMIN ** GROUP_ADMIN - [Invite User with privileged IAM Role](https://iam-docs.platform.ai71services.ai/api-reference/authorization/invite-user-with-privileged-iam-role.md): Invite User with privileged IAM role - [List of Active and Expired Sessions](https://iam-docs.platform.ai71services.ai/api-reference/authorization/list-of-active-and-expired-sessions.md): Provides a list of active and expired sessions Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER Note: if the session was not revoked/terminated before its expiration, it will be part of the list with expirationDate key in the response - [List/Search Organization's Groups](https://iam-docs.platform.ai71services.ai/api-reference/authorization/listsearch-organizations-groups.md): Provides a list of groups part of the organization along with search parameters Group Name supports case insensitive partial text search Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_ADMIN - [Search Organizations](https://iam-docs.platform.ai71services.ai/api-reference/authorization/search-organizations.md): Search Organizations Please note that passing the additional query params like includeMetadata, includeMembers etc. adds up to latency Therefore use them only if required Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Search users](https://iam-docs.platform.ai71services.ai/api-reference/authorization/search-users.md): Searches list of users in the app Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Search Users of an organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/search-users-of-an-organization.md): Search Users of an organization The search operation is exclusive and applies AND logic between parameters. This means that if multiple parameters are provided (e.g., name, email, and role), only users that match all specified criteria will be returned. email and name… - [Setup Organization](https://iam-docs.platform.ai71services.ai/api-reference/authorization/setup-organization.md): Setup Organization Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER Note: This endpoint is only for internal use only. - [Setup Organization Group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/setup-organization-group.md): Setup Group under existing Organization Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_ADMIN - [Udpate Organization Data](https://iam-docs.platform.ai71services.ai/api-reference/authorization/udpate-organization-data.md): Update Organization Data Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_OWNER - [Update Group](https://iam-docs.platform.ai71services.ai/api-reference/authorization/update-group.md): Updates a group and its settings. Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_ADMIN ** GROUP_ADMIN - [Update LDAP Identity Provider](https://iam-docs.platform.ai71services.ai/api-reference/authorization/update-ldap-identity-provider.md): Update LDAP Identity Provider Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER - [Update Member Roles](https://iam-docs.platform.ai71services.ai/api-reference/authorization/update-member-roles.md): Update Member Roles Roles Allowed: ** SUPER_ADMIN ** ORG_OWNER ** ORG_USER_MANAGER ** GENERIC_MACHINE_USER - [Update organization login settings](https://iam-docs.platform.ai71services.ai/api-reference/authorization/update-organization-login-settings.md): Update organization login settings Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_OWNER - [Verify email and enable MFA for user](https://iam-docs.platform.ai71services.ai/api-reference/authorization/verify-email-and-enable-mfa-for-user.md): Verify email and enable MFA for user Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER ** ORG_OWNER - [Authenticate user using LDAP protocol with LDAP IDP and username/password](https://iam-docs.platform.ai71services.ai/api-reference/idp-authentication/authenticate-user-using-ldap-protocol-with-ldap-idp-and-usernamepassword.md): Create LDAP Intent by id, then validate LDAP intent and return session details - [Create Idp Intent by id](https://iam-docs.platform.ai71services.ai/api-reference/idp-authentication/create-idp-intent-by-id.md): Create Idp Intent by id - [Validate Idp Intent](https://iam-docs.platform.ai71services.ai/api-reference/idp-authentication/validate-idp-intent.md): Validate Idp Intent by id and idp token - [Get app metadata](https://iam-docs.platform.ai71services.ai/api-reference/metadata/get-app-metadata.md): Return app metadata and idp configs - [Get org metadata](https://iam-docs.platform.ai71services.ai/api-reference/metadata/get-org-metadata.md): Return org metadata and idp configs - [Dependency Health Check](https://iam-docs.platform.ai71services.ai/api-reference/probes/dependency-health-check.md): Health Check for the app and dependencies - [Health Check](https://iam-docs.platform.ai71services.ai/api-reference/probes/health-check.md): Health Check for the app - [Sign In By Email and Password](https://iam-docs.platform.ai71services.ai/api-reference/v2-:-authentication/sign-in-by-email-and-password.md): Sign in By Email and Password - [Verify session using MFA](https://iam-docs.platform.ai71services.ai/api-reference/v2-:-authentication/verify-session-using-mfa.md): Verify session using MFA - [Create User In Organization](https://iam-docs.platform.ai71services.ai/api-reference/v2-:-authorization/create-user-in-organization.md): Create User In Organization - [Predefined Application Roles](https://iam-docs.platform.ai71services.ai/api-tutorials/application-features/predefined-app-roles.md) - [Current Feature List](https://iam-docs.platform.ai71services.ai/current-features.md) - [High level design & Workflow](https://iam-docs.platform.ai71services.ai/introduction.md) - [JavaScript SDK](https://iam-docs.platform.ai71services.ai/libraries/javascript.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/components/forgot-password.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/components/sign-in.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/components/sign-up.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/components/user-details.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/composite-elements/forgot-password-elements/request-code-form.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/composite-elements/forgot-password-elements/update-password-form.md) - [Overview](https://iam-docs.platform.ai71services.ai/libraries/react/composite-elements/overview.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/composite-elements/sign-in-elements/sign-in-form.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/composite-elements/sign-up-elements/sign-up-form.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/composite-elements/sign-up-elements/verify-form.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/composite-elements/user-details-elements/profile-form.md) - [](https://iam-docs.platform.ai71services.ai/libraries/react/composite-elements/user-details-elements/security-form.md) - [useRequestForgotPasswordCodeByEmail()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/basic/use-request-forgot-password-code-by-email.md) - [useSession()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/basic/use-session.md) - [useSignIn()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/basic/use-sign-in.md) - [useSignOut()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/basic/use-sign-out.md) - [useSignUp()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/basic/use-sign-up.md) - [useUpdatePasswordWithCode()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/basic/use-update-password-with-code.md) - [useVerifyUserEmail()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/basic/use-verify-user-email.md) - [useAppMetadata()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/oauth/use-app-metadata.md) - [useCreateIdentityProviderIntent()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/oauth/use-create-identity-provider-intent.md) - [useValidateIdentityProviderIntent()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/oauth/use-validate-identity-provider-intent.md) - [useChangeLanguage()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/other/use-change-language.md) - [Overview](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/overview.md) - [useUpdateUserPasswordWithCurrentPassword()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/user-details/use-update-user-password-with-current-password.md) - [useUpdateUserProfile()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/user-details/use-update-user-profile.md) - [useUserDetails()](https://iam-docs.platform.ai71services.ai/libraries/react/hooks/user-details/use-user-details.md) - [Overview](https://iam-docs.platform.ai71services.ai/libraries/react/overview.md) - [Quickstart](https://iam-docs.platform.ai71services.ai/libraries/react/quickstart.md) - [Roadmap](https://iam-docs.platform.ai71services.ai/roadmap.md) ## OpenAPI Specs - [api-json](https://dev-iam.razi.ai/api-json) - [openapi-from-anchor-url-2](https://iam-docs.platform.ai71services.ai/openapi-from-anchor-url-2) - [api_doc](https://iam-docs.platform.ai71services.ai/specs/api_doc.json) - [openapi](https://iam-docs.platform.ai71services.ai/api-reference/openapi.json) ## Optional - [Slack](https://locai-workspace.slack.com/archives/C07GY8L0NPK)