1"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([["11330"],{19414(e,s,n){n.r(s),n.d(s,{metadata:()=>l,default:()=>c,frontMatter:()=>i,contentTitle:()=>d,toc:()=>o,assets:()=>a});var l=JSON.parse('{"id":"api/auth/userpass","title":"Userpass auth method (HTTP API)","description":"This is the API documentation for the OpenBao username and password\\nauth method.","source":"@site/versioned_docs/version-2.6.x/api/auth/userpass.mdx","sourceDirName":"api/auth","slug":"/api/auth/userpass","permalink":"/docs/2.6.x/api/auth/userpass","draft":false,"unlisted":false,"editUrl":"https://github.com/openbao/openbao/blob/release/2.6.x/website/content/docs/api/auth/userpass.mdx","tags":[],"version":"2.6.x","frontMatter":{"sidebar_label":"Username and Password","description":"This is the API documentation for the OpenBao username and password\\nauth method."},"sidebar":"api","previous":{"title":"Tokens","permalink":"/docs/2.6.x/api/auth/token"},"next":{"title":"Overview","permalink":"/docs/2.6.x/api/system/"}}'),t=n(94686),r=n(44812);let i={sidebar_label:"Username and Password",description:"This is the API documentation for the OpenBao username and password\nauth method."},d="Userpass auth method (HTTP API)",a={},o=[{value:"Create/Update user",id:"createupdate-user",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Sample payload",id:"sample-payload",level:3},{value:"Sample request",id:"sample-request",level:3},{value:"Read user",id:"read-user",level:2},{value:"Sample request",id:"sample-request-1",level:3},{value:"Sample response",id:"sample-response",level:3},{value:"Delete user",id:"delete-user",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Sample request",id:"sample-request-2",level:3},{value:"Update password on user",id:"update-password-on-user",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Sample payload",id:"sample-payload-1",level:3},{value:"Sample request",id:"sample-request-3",level:3},{value:"Update policies on user",id:"update-policies-on-user",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Sample payload",id:"sample-payload-2",level:3},{value:"Sample request",id:"sample-request-4",level:3},{value:"List users",id:"list-users",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Sample request",id:"sample-request-5",level:3},{value:"Sample response",id:"sample-response-1",level:3},{value:"Login",id:"login",level:2},{value:"Parameters",id:"parameters-5",level:3},{value:"Sample payload",id:"sample-payload-3",level:3},{value:"Sample request",id:"sample-request-6",level:3},{value:"Sample response",id:"sample-response-2",level:3}];function h(e){let s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"userpass-auth-method-http-api",children:"Userpass auth method (HTTP API)"})}),"\n",(0,t.jsxs)(s.p,{children:["This is the API documentation for the OpenBao Username & Password auth method. For\ngeneral information about the usage and operation of the Username and Password method, please\nsee the ",(0,t.jsx)(s.a,{href:"/docs/2.6.x/auth/userpass",children:"OpenBao Userpass method documentation"}),"."]}),"\n",(0,t.jsxs)(s.p,{children:["This documentation assumes the Username & Password method is mounted at the ",(0,t.jsx)(s.code,{children:"/auth/userpass"}),"\npath in OpenBao. Since it is possible to enable auth methods at any location,\nplease update your API calls accordingly."]}),"\n",(0,t.jsx)(s.h2,{id:"createupdate-user",children:"Create/Update user"}),"\n",(0,t.jsxs)(s.p,{children:["Create a new user or update an existing user. This path honors the distinction between the ",(0,t.jsx)(s.code,{children:"create"})," and ",(0,t.jsx)(s.code,{children:"update"})," capabilities inside ACL policies."]}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Method"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Path"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"POST"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"/auth/userpass/users/:username"})})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"username"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"}),' \u2013 The username for the user. Accepted characters: alphanumeric plus "_", "-", "." (underscore, hyphen and period); username cannot begin with a hyphen, nor can it begin or end with a period.']}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"password"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"})," - The password for the user. Only required when creating the user."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"password_hash"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"})," - Pre-hashed bcrypt password for this user. Mutually exclusive with ",(0,t.jsx)(s.code,{children:"password"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_ttl"})," ",(0,t.jsx)(s.code,{children:'(integer: 0 or string: "")'})," - The incremental lifetime for\ngenerated tokens. This current value of this will be referenced at renewal\ntime."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_max_ttl"})," ",(0,t.jsx)(s.code,{children:'(integer: 0 or string: "")'})," - The maximum lifetime for\ngenerated tokens. This current value of this will be referenced at renewal\ntime."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_policies"})," ",(0,t.jsx)(s.code,{children:'(array: [] or comma-delimited string: "")'})," - List of\ntoken policies to encode onto generated tokens. Depending on the auth method, this\nlist may be supplemented by user/group/other values."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"policies"})," ",(0,t.jsx)(s.code,{children:'(array: [] or comma-delimited string: "")'})," - DEPRECATED: Please\nuse the ",(0,t.jsx)(s.code,{children:"token_policies"})," parameter instead. List of token policies to encode\nonto generated tokens. Depending on the auth method, this list may be\nsupplemented by user/group/other values."]}),"\n"]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_bound_cidrs"})," ",(0,t.jsx)(s.code,{children:'(array: [] or comma-delimited string: "")'}
1)," - List of\nCIDR blocks; if set, specifies blocks of IP addresses which can authenticate\nsuccessfully, and ties the resulting token to these blocks as well."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_strictly_bind_ip"})," ",(0,t.jsx)(s.code,{children:"(bool: false)"})," - If set, the token will be\nrestricted to the source IP address making the initial login request. This\nconflicts with ",(0,t.jsx)(s.code,{children:"token_bound_cidrs"}),"."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_explicit_max_ttl"})," ",(0,t.jsx)(s.code,{children:'(integer: 0 or string: "")'})," - If set, will encode\nan ",(0,t.jsx)(s.a,{href:"/docs/concepts/tokens#token-time-to-live-periodic-tokens-and-explicit-max-ttls",children:"explicit max\nTTL"}),"\nonto the token. This is a hard cap even if ",(0,t.jsx)(s.code,{children:"token_ttl"})," and ",(0,t.jsx)(s.code,{children:"token_max_ttl"}),"\nwould otherwise allow a renewal."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_no_default_policy"})," ",(0,t.jsx)(s.code,{children:"(bool: false)"})," - If set, the ",(0,t.jsx)(s.code,{children:"default"})," policy will\nnot be set on generated tokens; otherwise it will be added to the policies set\nin ",(0,t.jsx)(s.code,{children:"token_policies"}),"."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_num_uses"})," ",(0,t.jsx)(s.code,{children:"(integer: 0)"})," - The maximum number of times a generated\ntoken may be used (within its lifetime); 0 means unlimited.\nIf you require the token to have the ability to create child tokens,\nyou will need to set this value to 0."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_period"})," ",(0,t.jsx)(s.code,{children:'(integer: 0 or string: "")'})," - The maximum allowed ",(0,t.jsx)(s.a,{href:"/docs/concepts/tokens#token-time-to-live-periodic-tokens-and-explicit-max-ttls",children:"period"})," value when a periodic token is requested from this role."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_type"})," ",(0,t.jsx)(s.code,{children:'(string: "")'})," - The type of token that should be generated. Can\nbe ",(0,t.jsx)(s.code,{children:"service"}),", ",(0,t.jsx)(s.code,{children:"batch"}),", or ",(0,t.jsx)(s.code,{children:"default"})," to use the mount's tuned default (which\nunless changed will be ",(0,t.jsx)(s.code,{children:"service"})," tokens). For token store roles, there are two\nadditional possibilities: ",(0,t.jsx)(s.code,{children:"default-service"})," and ",(0,t.jsx)(s.code,{children:"default-batch"})," which specify\nthe type to return unless the client requests a different type at generation\ntime."]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"sample-payload",children:"Sample payload"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-json",children:'{\n "password": "superSecretPassword",\n "token_policies": ["admin", "default"],\n "token_bound_cidrs": ["127.0.0.1/32", "128.252.0.0/16"]\n}\n'})}),"\n",(0,t.jsx)(s.h3,{id:"sample-request",children:"Sample request"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-shell-session",children:'$ curl \\\n --header "X-Vault-Token: ..." \\\n --request POST \\\n --data @payload.json \\\n http://127.0.0.1:8200/v1/auth/userpass/users/mitchellh\n'})}),"\n",(0,t.jsx)(s.h2,{id:"read-user",children:"Read user"}),"\n",(0,t.jsx)(s.p,{children:"Reads the properties of an existing username."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Method"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Path"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"GET"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"/auth/userpass/users/:username"})})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"sample-request-1",children:"Sample request"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-shell-session",children:'$ curl \\\n --header "X-Vault-Token: ..." \\\n http://127.0.0.1:8200/v1/auth/userpass/users/mitchellh\n'})}),"\n",(0,t.jsx)(s.h3,{id:"sample-response",children:"Sample response"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-json",children:'{\n "request_id": "0ad1be52-9398-4b3c-f58b-98e427406471",\n "lease_id": "",\n "renewable": false,\n "lease_duration": 0,\n "data": {\n "token_bound_cidrs": [\n "127.0.0.1",\n "128.252.0.0/16"\n ],\n "token_explicit_max_ttl": 0,\n "token_max_ttl": 0,\n "token_no_default_policy": false,\n "token_num_uses": 0,\n "token_period": 0,\n "token_policies": [\n "admin",\n "default"\n ],\n "token_ttl": 0,\n "token_type": "default"\n },\n "wrap_info": null,\n "warnings": null,\n "auth": null\n}\n'})}),"\n",(0,t.jsx)(s.h2,{id:"delete-user",children:"Delete user"}),"\n",(0,t.jsx)(s.p,{children:"This endpoint deletes the user from the method."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Method"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Path"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"DELETE"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"/auth/userpass/users/:username"})})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"username"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"})," - The username for the user."]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"sample-request-2",children:"Sample request"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-shell-session",children:'$ curl \\\n --header "X-Vault-Token: ..." \\\n --request DELETE \\\n http://127.0.0.1:8200/v1/auth/userpass/users/mitchellh\n'})}),"\n",(0,t.jsx)(s.h2,{id:"update-password-on-user",children:"Update password on user"}),"\n",(0,t.jsx)(s.p,{children:"Update password for an existing user."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Method"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Path"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"POST"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"/auth/userpass/users/:username/password"})})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"username"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"})," \u2013 The username for the user."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"password"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"})," - The password for the user."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"password_hash"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"})," - Pre-hashed bcrypt password for this user. Mutually exclusive with ",(0,t.jsx)(s.code,{children:"password"}),"."]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"sample-payload-1",children:"Sample payload"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-json",children:'{\n "password": "superSecretPassword2"\n}\n'})}),"\n",(0,t.jsx)(s.h3,{id:"sample-request-3",children:"Sample request"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-shell-session",children:'$ curl \\\n --header "X-Vault-Token: ..." \\\n --request POST \\\n --data @payload.json \\\n http://127.0.0.1:8200/v1/auth/userpass/users/mitchellh/password\n'})}),"\n",(0,t.jsx)(s.h2,{id:"update-policies-on-user",children:"Update policies on user"}),"\n",(0,t.jsx)(s.p,{children:"Update policies for an existing user."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Method"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Path"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"POST"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"/auth/userpass/users/:username/policies"})})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"username"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"})," \u2013 The username for the user."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"token_policies"})," ",(0,t.jsx)(s.code,{children:'(array: [] or comma-delimited string: "")'})," - List of\npolicies to encode onto generated tokens. Depending on the auth method, this\nlist may be supplemented by user/group/other values."]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"sample-payload-2",children:"Sample payload"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-json",children:'{\n "token_policies": ["policy1", "policy2"]\n}\n'})}),"\n",(0,t.jsx)(s.h3,{id:"sample-request-4",children:"Sample request"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-shell-session",children:'$ curl \\\n --header "X-Vault-Token: ..." \\\n --request POST \\\n --data @payload.json \\\n http://127.0.0.1:8200/v1/auth/userpass/users/mitchellh/policies\n'})}),"\n",(0,t.jsx)(s.h2,{id:"list-users",children:"List users"}),"\n",(0,t.jsx)(s.p,{children:"List available userpass users."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Method"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Path"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"LIST"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"/auth/userpass/users"})})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"after"})," ",(0,t.jsx)(s.code,{children:'(string: "")'})," - Optional entry to begin listing after for\npagination; not required to exist."]}),"\n"]}),"\n",(0,t.jsxs)(s.li,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"limit"})," ",(0,t.jsx)(s.code,{children:"(int: 0)"})," - Optional number of entries to return; defaults\nto all entries."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"sample-request-5",children:"Sample request"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-shell-session",children:'$ curl \\\n --header "X-Vault-Token: ..." \\\n --request LIST \\\n http://127.0.0.1:8200/v1/auth/userpass/users\n'})}),"\n",(0,t.jsx)(s.h3,{id:"sample-response-1",children:"Sample response"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-json",children:'{\n "data": {\n "ke
1ys": ["mitchellh", "armon"]\n }\n}\n'})}),"\n",(0,t.jsx)(s.h2,{id:"login",children:"Login"}),"\n",(0,t.jsx)(s.p,{children:"Login with the username and password."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Method"}),(0,t.jsx)(s.th,{style:{textAlign:"left"},children:"Path"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"POST"})}),(0,t.jsx)(s.td,{style:{textAlign:"left"},children:(0,t.jsx)(s.code,{children:"/auth/userpass/login/:username"})})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"parameters-5",children:"Parameters"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"username"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"})," \u2013 The username for the user."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.code,{children:"password"})," ",(0,t.jsx)(s.code,{children:"(string: <required>)"})," - The password for the user."]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"sample-payload-3",children:"Sample payload"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-json",children:'{\n "password": "superSecretPassword2"\n}\n'})}),"\n",(0,t.jsx)(s.h3,{id:"sample-request-6",children:"Sample request"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-shell-session",children:"$ curl \\\n --request POST \\\n --data @payload.json \\\n http://127.0.0.1:8200/v1/auth/userpass/login/mitchellh\n"})}),"\n",(0,t.jsx)(s.h3,{id:"sample-response-2",children:"Sample response"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-json",children:'{\n "request_id": "ae1882ba-f60a-7629-ce1a-6618c482de3e",\n "lease_id": "",\n "renewable": false,\n "lease_duration": 0,\n "data": null,\n "wrap_info": null,\n "warnings": null,\n "auth": {\n "client_token": "hvs.CAESIJyeFmhLYRWVXPJStT3fDP1ZdFkon_otuk1sJUpkfk_WGh4KHGh2cy5xdW9XVHBnVUwwbzB1ZEhzZkpkRmVoU08",\n "accessor": "iP2Lw1JXpjlALbgJSeIx51n7",\n "policies": [\n "default",\n "policy1",\n "policy2"\n ],\n "token_policies": [\n "default",\n "policy1",\n "policy2"\n ],\n "metadata": {\n "username": "mitchellh"\n },\n "lease_duration": 2764800,\n "renewable": true,\n "entity_id": "0660dce5-4f2c-926a-8b15-158901557d9d",\n "token_type": "service",\n "orphan": true,\n "mfa_requirement": null,\n "num_uses": 0\n }\n}\n'})})]})}function c(e={}){let{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},44812(e,s,n){n.d(s,{R:()=>i,x:()=>d});var l=n(92990);let t={},r=l.createContext(t);function i(e){let s=l.useContext(r);return l.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),l.createElement(r.Provider,{value:s},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.