Only a super Admin user is allowed to proceed with this flow.Make sure to either:
Send a valid Authorization header with of type Bearer TOKEN_VALUE where TOKEN_VALUE is the token generated for the super admin.
In case your app supports cookie, you can enable request cookies as our API Automatically sets a cookie named session-token which is forwarded with each request to our api.
To generate an access token for a machine or service user, you will first need to obtain the machine user’s client ID and secret.
These credentials can be used to authenticate and gain access to the API programmatically.
1
Obtain Machine User Credentials
First, create a machine user by making a POST request to the appropriate endpoint
(as described in this section).
The response will include the machine user’s clientId and clientSecret.
2
Generate Access Token
Use the clientId and clientSecret obtained from the machine user creation
API to generate an access token.
The access token is required to authenticate subsequent API requests.
Please note that if the token is expired after the time specified in the expiresInSeconds field,
a new token needs to be generated to access the API resources.
This token can now be used to authenticate API requests on behalf of the machine user
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Locai IAM Service Docs","colors":{"primary":"#2392eb","light":"#3295e7","dark":"#1b8ae4"},"favicon":"/images/favicon.png","logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/locai-1a415a09/logo/ai71-logo.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/locai-1a415a09/logo/ai71-logo-dark.svg"},"seo":{"metatags":{"og:title":"Locai IAM Service Docs","og:image":"/images/favicon.png","og:description":"Docs for IAM Service related modules","og:logo":"/logo/ai71-logo.svg"},"indexing":"navigable"},"fonts":{"family":"Darker Grotesque"},"navigation":{"global":{"anchors":[{"anchor":"Slack","href":"https://locai-workspace.slack.com/archives/C07GY8L0NPK","icon":{"name":"slack","style":"solid"}}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"locai-1a415a09","hasAudioNarration":false,"actualSubdomain":"locai-1a415a09","customDomains":["iam-docs.platform.ai71services.ai"],"gitSource":{"type":"github","owner":"udayakumarrajan-locai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e679044dd579e9b5798c","collectionId":"2a4bed33-1a1c-4eb8-be21-12c33fd457c2","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e679044dd579e9b5798c:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":83},{"language":"default","tag":"SDK (beta)","count":60},{"language":"default","tag":"Authorization","count":57},{"language":"default","tag":"React SDK","count":29},{"language":"default","tag":"Authentication","count":16},{"language":"default","tag":"Hooks","count":15},{"language":"default","tag":"Composite Elements","count":8},{"language":"default","tag":"Basic","count":7},{"language":"default","tag":"User Details","count":5},{"language":"default","tag":"Introduction","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".prose :where(h2):not(:where([class~=not-prose],[class~=not-prose] *)){color:var(--tw-prose-headings);font-weight:700;font-size:2em;margin-top:2em;margin-bottom:.6666666666666666em;line-height:1.3333333}p{font-weight:500}li,p{font-size:1.1em}.text-base{font-size:1.3rem}.font-normal{font-weight:400;font-size:.9rem}h5{font-size:1.4rem}div{font-size:1.1rem}.text-sm{font-size:1rem;line-height:1.25rem}.language-bash,.language-plaintext,.language-python,.language-typescript{font-size:.89rem}@media (min-width:640px){.sm\\:flex{display:none}}#r5{font-family:inherit;font-size:16px;fill:#333}.language-json,.language-sql{font-size:.89rem}.text-gray-900{color:rgb(var(--gray-900));font-size:1rem}"}],"page":{"pagePath":"api-tutorials/unauthenticated-flows/generate-machine-user-token","slug":"/api-tutorials/unauthenticated-flows/generate-machine-user-token","pageMetadata":{"sidebar_position":2,"title":"Access Token Generation for Machine User","icon":"universal-access","iconType":"solid","description":null,"href":"/api-tutorials/unauthenticated-flows/generate-machine-user-token"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Info,Note,Step,Steps,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(Warning,{children:[_jsx(_components.p,{children:`Only a super Admin user is allowed to proceed with this flow.`}),_jsx(_components.p,{children:`Make sure to either:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Send a valid `,_jsx(_components.code,{children:`Authorization`}),` header with of type `,_jsx(_components.code,{children:`Bearer TOKEN_VALUE`}),` where `,_jsx(_components.strong,{children:`TOKEN_VALUE`}),` is the token generated for the super admin.`]}),`\n`,_jsxs(_components.li,{children:[`In case your app supports cookie, you can enable request cookies as our API Automatically sets a cookie named `,_jsx(_components.code,{children:`session-token`}),` which is forwarded with each request to our api.`]}),`\n`]})]}),`\n`,_jsx(_components.p,{children:`To generate an access token for a machine or service user, you will first need to obtain the machine user’s client ID and secret.\nThese credentials can be used to authenticate and gain access to the API programmatically.`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Obtain Machine User Credentials`,children:_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`First, create a machine user by making a POST request to the appropriate endpoint\n(as described in `,_jsx(_components.strong,{children:_jsx(_components.a,{href:`/api-tutorials/authenticated-flows/create-machine-user`,children:`this`})}),` section).`]}),`\n`,_jsx(_components.li,{children:`The response will include the machine user’s clientId and clientSecret.`}),`\n`]})}),_jsxs(Step,{title:`Generate Access Token`,children:[_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Use the clientId and clientSecret obtained from the machine user creation\nAPI to generate an access token.`}),`\n`,_jsx(_components.li,{children:`The access token is required to authenticate subsequent API requests.`}),`\n`]}),_jsx(CodeBlock,{numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://dev-iam.razi.ai/v1/authentication/machine-users/access-token`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-App-Name: '`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"clientId\": \"example-client-id\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"clientSecret\": \"zNUTk6frtcdrpEbRiOYx3lGjZpou1oRGVxt40SUj2qkBzUVh8gybTmOObmFvDPKw\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}'`})}),`\n`]})})}),_jsx(_components.p,{children:`Upon successful generation of the access token, you will receive a response similar to the below:`}),_jsx(CodeBlock,{numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"token\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003cJWT TOKEN>\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"expiresInSeconds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`43199`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(Note,{children:_jsx(_components.p,{children:`Please note that if the token is expired after the time specified in the expiresInSeconds field,\na new token needs to be generated to access the API resources.`})})]})]}),`\n`,_jsx(Info,{children:_jsx(_components.p,{children:`This token can now be used to authenticate API requests on behalf of the machine user`})}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:_jsx(_components.a,{href:`https://dev-iam.razi.ai/docs#tag/authentication/POST/v1/authentication/machine-users/access-token`,children:`Link to Playground`})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"sidebar_position":2,"title":"Access Token Generation for Machine User","icon":"universal-access","iconType":"solid","description":null,"href":"/api-tutorials/unauthenticated-flows/generate-machine-user-token"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"locai-1a415a09","siteName":"Locai IAM Service Docs","title":"Locai IAM Service Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-tutorials/unauthenticated-flows/generate-machine-user-token.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Locai IAM Service Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/locai-1a415a09/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/locai-1a415a09/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/locai-1a415a09/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/locai-1a415a09/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Locai IAM Service Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Docs for IAM Service related modules\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Locai IAM Service Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://iam-docs.platform.ai71services.ai/api-tutorials/unauthenticated-flows/generate-machine-user-token\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://locai-1a415a09.mintlify.app/images/favicon.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Locai IAM Service Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Docs for IAM Service related modules\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://locai-1a415a09.mintlify.app/images/favicon.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/locai-1a415a09/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Locai IAM Service Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2392eb\">\u003cmeta data-mint-head name=\"og:logo\" content=\"/logo/ai71-logo.svg\">\u003clink data-mint-head rel=\"canonical\" href=\"https://iam-docs.platform.ai71services.ai/api-tutorials/unauthenticated-flows/generate-machine-user-token\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-tutorials/unauthenticated-flows/generate-machine-user-token.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Locai IAM Service Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Locai IAM Service Docs","nav":{"global":{"anchors":[{"anchor":"Slack","href":"https://locai-workspace.slack.com/archives/C07GY8L0NPK","icon":{"name":"slack","style":"solid"}}]},"tabs":[{"tab":"Introduction","groups":[{"group":"","pages":[{"title":"High level design \u0026 Workflow","icon":"city","href":"/introduction"},{"title":"Current Feature List","icon":"list-timeline","href":"/current-features"},{"group":"Application Features","icon":{"name":"rocket","style":"solid"},"pages":[{"title":"Predefined Application Roles","icon":"globe","iconType":"solid","href":"/api-tutorials/application-features/predefined-app-roles"}]},{"title":"Roadmap","icon":"arrow-progress","href":"/roadmap"}]}]},{"tab":"SDK (beta)","groups":[{"group":"SDK (beta)","pages":[{"title":"JavaScript SDK","icon":"js","iconType":"solid","href":"/libraries/javascript"},{"group":"React SDK","icon":{"name":"react","style":"solid"},"pages":[{"title":"Overview","href":"/libraries/react/overview"},{"title":"Quickstart","href":"/libraries/react/quickstart"},{"group":"Components","icon":"rectangle-code","pages":[{"title":"\u003cSignIn />","href":"/libraries/react/components/sign-in"},{"title":"\u003cSignUp />","href":"/libraries/react/components/sign-up"},{"title":"\u003cForgotPassword />","href":"/libraries/react/components/forgot-password"},{"title":"\u003cUserDetails />","href":"/libraries/react/components/user-details"}]},{"group":"Composite Elements","icon":"rectangles-mixed","pages":[{"title":"Overview","href":"/libraries/react/composite-elements/overview"},{"group":"Sign In","pages":[{"title":"\u003cSignInForm />","href":"/libraries/react/composite-elements/sign-in-elements/sign-in-form"}]},{"group":"Sign Up","pages":[{"title":"\u003cSignUpForm />","href":"/libraries/react/composite-elements/sign-up-elements/sign-up-form"},{"title":"\u003cVerifyForm />","href":"/libraries/react/composite-elements/sign-up-elements/verify-form"}]},{"group":"Forgot Password","pages":[{"title":"\u003cRequestCodeForm />","href":"/libraries/react/composite-elements/forgot-password-elements/request-code-form"},{"title":"\u003cUpdatePasswordForm />","href":"/libraries/react/composite-elements/forgot-password-elements/update-password-form"}]},{"group":"User Details","pages":[{"title":"\u003cProfileForm />","href":"/libraries/react/composite-elements/user-details-elements/profile-form"},{"title":"\u003cSecurityForm />","href":"/libraries/react/composite-elements/user-details-elements/security-form"}]}]},{"group":"Hooks","icon":"webhook","pages":[{"title":"Overview","href":"/libraries/react/hooks/overview"},{"group":"Basic","pages":[{"title":"useSession()","href":"/libraries/react/hooks/basic/use-session"},{"title":"useSignIn()","href":"/libraries/react/hooks/basic/use-sign-in"},{"title":"useSignUp()","href":"/libraries/react/hooks/basic/use-sign-up"},{"title":"useSignOut()","href":"/libraries/react/hooks/basic/use-sign-out"},{"title":"useRequestForgotPasswordCodeByEmail()","href":"/libraries/react/hooks/basic/use-request-forgot-password-code-by-email"},{"title":"useUpdatePasswordWithCode()","href":"/libraries/react/hooks/basic/use-update-password-with-code"},{"title":"useVerifyUserEmail()","href":"/libraries/react/hooks/basic/use-verify-user-email"}]},{"group":"OAuth","pages":[{"title":"useAppMetadata()","href":"/libraries/react/hooks/oauth/use-app-metadata"},{"title":"useCreateIdentityProviderIntent()","href":"/libraries/react/hooks/oauth/use-create-identity-provider-intent"},{"title":"useValidateIdentityProviderIntent()","href":"/libraries/react/hooks/oauth/use-validate-identity-provider-intent"}]},{"group":"User Details","pages":[{"title":"useUserDetails()","href":"/libraries/react/hooks/user-details/use-user-details"},{"title":"useUpdateUserProfile()","href":"/libraries/react/hooks/user-details/use-update-user-profile"},{"title":"useUpdateUserPasswordWithCurrentPassword()","href":"/libraries/react/hooks/user-details/use-update-user-password-with-current-password"}]},{"group":"Other","pages":[{"title":"useChangeLanguage()","href":"/libraries/react/hooks/other/use-change-language"}]}]}]}]}]},{"tab":"API Reference","groups":[{"group":"Metadata","pages":[{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authentication/org-metadata","href":"/api-reference/metadata/get-org-metadata","title":"Get org metadata","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authentication/apps/metadata","href":"/api-reference/metadata/get-app-metadata","title":"Get app metadata","version":null}]},{"group":"Authentication","pages":[{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authentication/users","href":"/api-reference/authentication/create-user-by-email-and-password","title":"Create User By Email and Password","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authentication/users/login","href":"/api-reference/authentication/sign-in-by-email-and-password","title":"Sign In By Email and Password","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authentication/users/password/reset-request/email","href":"/api-reference/authentication/request-password-reset-code-by-email","title":"Request password reset code by email","version":null},{"openapi":"https://dev-iam.razi.ai/api-json put /v1/authentication/users/password","href":"/api-reference/authentication/update-user-password-using-email-and-verification-code","title":"Update user password using email and verification code","version":null},{"openapi":"https://dev-iam.razi.ai/api-json put /v1/authentication/users/invite","href":"/api-reference/authentication/accept-user-invite-with-email-and-verification-code","title":"Accept user invite with email and verification code","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authentication/token/jwks","href":"/api-reference/authentication/get-user-jwks","title":"Get User JWKs","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authentication/machine-users/access-token","href":"/api-reference/authentication/generate-access-token-for-machine-user","title":"Generate Access Token for Machine User","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authentication/user/organizations","href":"/api-reference/authentication/get-user-organizations-by-email","title":"Get user organizations by email","version":null},{"openapi":"https://dev-iam.razi.ai/api-json put /v1/authentication/users/{userId}/password","href":"/api-reference/authentication/update-user-password-using-current-password","title":"Update User Password using current password","version":null},{"openapi":"https://dev-iam.razi.ai/api-json delete /v1/authentication/users/sessions/{sessionId}","href":"/api-reference/authentication/sign-out-user-by-sessionid","title":"Sign Out user by sessionId","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authentication/users/me","href":"/api-reference/authentication/get-user-information-by-token","title":"Get user information by token","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authentication/users/me/manager-roles","href":"/api-reference/authentication/get-user-manager-roles-by-token","title":"Get User Manager Roles by token","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authentication/users/{userId}","href":"/api-reference/authentication/get-user-information-by-user-id","title":"Get user information by user id","version":null},{"openapi":"https://dev-iam.razi.ai/api-json put /v1/authentication/users/{userId}","href":"/api-reference/authentication/update-user-information","title":"Update user information","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authentication/users/email/verification-request","href":"/api-reference/authentication/request-to-send-email-verification-code","title":"Request to send email verification code","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authentication/users/email/verification","href":"/api-reference/authentication/verify-user-email","title":"Verify user email","version":null}]},{"group":"IDP Authentication","pages":[{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authentication/idp/intents/create","href":"/api-reference/idp-authentication/create-idp-intent-by-id","title":"Create Idp Intent by id","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authentication/idp/intents/validate","href":"/api-reference/idp-authentication/validate-idp-intent","title":"Validate Idp Intent","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authentication/ldap","href":"/api-reference/idp-authentication/authenticate-user-using-ldap-protocol-with-ldap-idp-and-usernamepassword","title":"Authenticate user using LDAP protocol with LDAP IDP and username/password","version":null}]},{"group":"V2 : Authentication","pages":[{"openapi":"https://dev-iam.razi.ai/api-json post /v2/authentication/users/login","href":"/api-reference/v2-:-authentication/sign-in-by-email-and-password","title":"Sign In By Email and Password","version":null},{"openapi":"https://dev-iam.razi.ai/api-json patch /v2/authentication/session/verify","href":"/api-reference/v2-:-authentication/verify-session-using-mfa","title":"Verify session using MFA","version":null}]},{"group":"Authorization","pages":[{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/users","href":"/api-reference/authorization/get-all-users","title":"Get all users","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/users","href":"/api-reference/authorization/create-user","title":"Create User","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/users/iam","href":"/api-reference/authorization/invite-user-with-privileged-iam-role","title":"Invite User with privileged IAM Role","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/members","href":"/api-reference/authorization/invite-user-in-organization","title":"Invite User in organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/admins","href":"/api-reference/authorization/invite-org-admin-in-organization","title":"Invite Org Admin in organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/managers","href":"/api-reference/authorization/invite-org-user-managers-in-organization","title":"Invite Org User managers in organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/setup","href":"/api-reference/authorization/setup-organization","title":"Setup Organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json put /v1/authorization/organizations/{orgId}/roles","href":"/api-reference/authorization/addupdate-roles-and-permissions-of-organization","title":"Add/Update Roles and Permissions of organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json put /v1/authorization/organizations/{orgId}/members/{userId}/roles","href":"/api-reference/authorization/update-member-roles","title":"Update Member Roles","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/user/{userId}/roles","href":"/api-reference/authorization/get-user-roles-for-logged-in-user","title":"Get User Roles for logged in user","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/user/{userId}/roles/byid","href":"/api-reference/authorization/get-user-roles-by-user-id","title":"Get User Roles by user id","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/users/{userId}/permissions","href":"/api-reference/authorization/check-permissions-of-user","title":"Check Permissions of User","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/idps/google","href":"/api-reference/authorization/add-identity-provider-for-google","title":"Add Identity Provider for Google","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/idps/azure","href":"/api-reference/authorization/add-identity-provider-for-microsoft-azuread","title":"Add Identity Provider for Microsoft AzureAD","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/{orgId}/idps","href":"/api-reference/authorization/get-organization-identity-providers-list","title":"Get Organization Identity Providers List","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/ldap","href":"/api-reference/authorization/add-ldap-identity-provider-and-link-to-organization","title":"Add LDAP Identity Provider and link to Organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json put /v1/authorization/ldap/{idpId}","href":"/api-reference/authorization/update-ldap-identity-provider","title":"Update LDAP Identity Provider","version":null},{"openapi":"https://dev-iam.razi.ai/api-json delete /v1/authorization/idps/{idpId}","href":"/api-reference/authorization/delete-identity-provider","title":"Delete Identity Provider","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/machine-users","href":"/api-reference/authorization/creates-a-machine-service-user","title":"Creates a Machine/ Service User","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations","href":"/api-reference/authorization/get-all-organizations","title":"Get All Organizations","version":null},{"openapi":"https://dev-iam.razi.ai/api-json delete /v1/authorization/users/{userId}","href":"/api-reference/authorization/delete-user","title":"Delete User","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/{orgId}/events","href":"/api-reference/authorization/get-organization-events","title":"Get Organization Events","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/users/search","href":"/api-reference/authorization/search-users-of-an-organization","title":"Search Users of an organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/users/{userId}","href":"/api-reference/authorization/add-user-to-org","title":"Add user to org","version":null},{"openapi":"https://dev-iam.razi.ai/api-json delete /v1/authorization/organizations/users/{userId}","href":"/api-reference/authorization/delete-user-from-org","title":"Delete user from org","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/users","href":"/api-reference/authorization/get-all-users-of-an-organization","title":"Get All Users of an organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/users/search","href":"/api-reference/authorization/search-users","title":"Search users","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/{orgId}","href":"/api-reference/authorization/get-organization-data","title":"Get Organization Data","version":null},{"openapi":"https://dev-iam.razi.ai/api-json patch /v1/authorization/organizations/{orgId}","href":"/api-reference/authorization/udpate-organization-data","title":"Udpate Organization Data","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/users/search/advanced","href":"/api-reference/authorization/advanced-user-search","title":"Advanced User Search","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/users/advanced","href":"/api-reference/authorization/get-all-users-with-advance-parameters","title":"Get all users with advance parameters","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/search","href":"/api-reference/authorization/search-organizations","title":"Search Organizations","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/users/{userId}/verify-email","href":"/api-reference/authorization/verify-email-and-enable-mfa-for-user","title":"Verify email and enable MFA for user","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/users/sessions","href":"/api-reference/authorization/list-of-active-and-expired-sessions","title":"List of Active and Expired Sessions","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/{orgId}/users/{userId}/sessions","href":"/api-reference/authorization/get-user-sessions-of-an-organization","title":"Get User Sessions of an organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/{orgId}/settings/login","href":"/api-reference/authorization/get-organization-login-settings","title":"Get organization login settings","version":null},{"openapi":"https://dev-iam.razi.ai/api-json patch /v1/authorization/organizations/{orgId}/settings/login","href":"/api-reference/authorization/update-organization-login-settings","title":"Update organization login settings","version":null},{"openapi":"https://dev-iam.razi.ai/api-json patch /v1/authorization/users/sessions/{sessionId}/extend","href":"/api-reference/authorization/extend-existing-session","title":"Extend existing Session","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/settings","href":"/api-reference/authorization/add-update-organization-custom-settings","title":"Add / Update Organization Custom Settings","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/{orgId}/groups","href":"/api-reference/authorization/listsearch-organizations-groups","title":"List/Search Organization's Groups","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/groups","href":"/api-reference/authorization/setup-organization-group","title":"Setup Organization Group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/groups/{groupId}/roles","href":"/api-reference/authorization/addupdate-roles-and-permissions-of-organization-group","title":"Add/Update Roles and Permissions of organization group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json delete /v1/authorization/organizations/{orgId}/groups/{groupId}/roles","href":"/api-reference/authorization/delete-roles-from-the-group","title":"Delete roles from the group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/{orgId}/groups/{groupId}/admins","href":"/api-reference/authorization/get-privileged-member-from-organization-group","title":"Get privileged member from organization group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/groups/{groupId}/admins","href":"/api-reference/authorization/invite-group-admin-in-organization-group","title":"Invite Group Admin in organization group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/{orgId}/groups/{groupId}/members","href":"/api-reference/authorization/get-all-users-of-an-organization-group","title":"Get All Users of an organization group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/groups/{groupId}/members","href":"/api-reference/authorization/invite-user-in-organization-group","title":"Invite User in organization group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/groups/{groupId}/members/{userId}/roles","href":"/api-reference/authorization/addupdate-group-users-roles","title":"Add/Update Group Users Roles","version":null},{"openapi":"https://dev-iam.razi.ai/api-json delete /v1/authorization/organizations/{orgId}/groups/{groupId}/members/{userId}","href":"/api-reference/authorization/delete-user-from-organization-group","title":"Delete User from organization group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/organizations/{orgId}/groups/{groupId}/members/{userId}/activate","href":"/api-reference/authorization/activate-inactive-user-from-organization-group","title":"Activate inactive user from organization group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json delete /v1/authorization/organizations/{orgId}/groups/{groupId}/admins/{userId}","href":"/api-reference/authorization/delete-privileged-member-from-organization-group","title":"Delete privileged member from organization group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json put /v1/authorization/organizations/{orgId}/groups/{groupId}","href":"/api-reference/authorization/update-group","title":"Update Group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json delete /v1/authorization/organizations/{orgId}/groups/{groupId}","href":"/api-reference/authorization/delete-group","title":"Delete Group","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/organizations/{orgId}/groups/members/{userId}","href":"/api-reference/authorization/get-users-groups-in-an-organization","title":"Get User's Groups in an Organization","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /v1/authorization/predefined-roles","href":"/api-reference/authorization/get-pre-defined-application-roles","title":"Get pre-defined application roles","version":null},{"openapi":"https://dev-iam.razi.ai/api-json post /v1/authorization/predefined-roles","href":"/api-reference/authorization/addupdate-pre-defined-application-roles","title":"Add/Update pre-defined application roles","version":null},{"openapi":"https://dev-iam.razi.ai/api-json delete /v1/authorization/predefined-roles","href":"/api-reference/authorization/delete-pre-defined-application-roles","title":"Delete pre-defined application roles","version":null}]},{"group":"V2 : Authorization","pages":[{"openapi":"https://dev-iam.razi.ai/api-json post /v2/authorization/organizations/{orgId}/members","href":"/api-reference/v2-:-authorization/create-user-in-organization","title":"Create User In Organization","version":null}]},{"group":"Probes","pages":[{"openapi":"https://dev-iam.razi.ai/api-json get /health","href":"/api-reference/probes/health-check","title":"Health Check","version":null},{"openapi":"https://dev-iam.razi.ai/api-json get /health/dependencies-check","href":"/api-reference/probes/dependency-health-check","title":"Dependency Health Check","version":null}]}]}]},"basePath":"","title":"Locai IAM Service Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":[],"chunks":[]}