1/*! For license information please see 469588bb.2e261d97.js.LICENSE.txt */ 2"use strict";(self.webpackChunkdevelopers_basistheory_com=self.webpackChunkdevelopers_basistheory_com||[]).push([[2679],{8523:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>h,default:()=>m,frontMatter:()=>o,metadata:()=>s,toc:()=>u});const s=JSON.parse('{"id":"api/tenants/tenant-members","title":"Tenant Members","description":"Tenant Members enable user management operations within the context of a Tenant.","source":"@site/docs/api/tenants/tenant-members.mdx","sourceDirName":"api/tenants","slug":"/api/tenants/tenant-members","permalink":"/docs/api/tenants/tenant-members","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedAt":1790618629000,"frontMatter":{"title":"Tenant Members"},"sidebar":"api","previous":{"title":"Tenants","permalink":"/docs/api/tenants/"},"next":{"title":"Tenant Merchants","permalink":"/docs/api/tenants/tenant-merchants"}}');var i=t(74848),a=t(28453),r=t(13187),l=t(83227),d=t(47363),c=t(2368);const o={title:"Tenant Members"},h="Tenant Members",j={},u=[{value:"List Tenant Members",id:"list-tenant-members",level:2},{value:"Permissions",id:"permissions",level:4},{value:"Request",id:"request",level:3},{value:"Query Parameters",id:"query-parameters",level:4},{value:"Response",id:"response",level:3},{value:"Delete Tenant Member",id:"delete-tenant-member",level:2},{value:"Permissions",id:"permissions-1",level:4},{value:"Request",id:"request-1",level:3},{value:"URI Parameters",id:"uri-parameters",level:4},{value:"Response",id:"response-1",level:3},{value:"Create Tenant Invitation",id:"create-tenant-invitation",level:2},{value:"Permissions",id:"permissions-2",level:4},{value:"Request",id:"request-2",level:3},{value:"Request Parameters",id:"request-parameters",level:4},{value:"Response",id:"response-2",level:3},{value:"Resend Tenant Invitation",id:"resend-tenant-invitation",level:2},{value:"Permissions",id:"permissions-3",level:4},{value:"Request",id:"request-3",level:3},{value:"URI Parameters",id:"uri-parameters-1",level:4},{value:"Response",id:"response-3",level:3},{value:"List Tenant Invitations",id:"list-tenant-invitations",level:2},{value:"Permissions",id:"permissions-4",level:4},{value:"Request",id:"request-4",level:3},{value:"Query Parameters",id:"query-parameters-1",level:4},{value:"Response",id:"response-4",level:3},{value:"Get a Tenant Invitation",id:"get-a-tenant-invitation",level:2},{value:"Permissions",id:"permissions-5",level:4},{value:"Request",id:"request-5",level:3},{value:"URI Parameters",id:"uri-parameters-2",level:4},{value:"Response",id:"response-5",level:3},{value:"Delete Tenant Invitation",id:"delete-tenant-invitation",level:2},{value:"Permissions",id:"permissions-6",level:4},{value:"Request",id:"request-6",level:3},{value:"URI Parameters",id:"uri-parameters-3",level:4},{value:"Response",id:"response-6",level:3},{value:"Tenant Member Object",id:"tenant-member-object",level:2},{value:"Roles",id:"roles",level:3},{value:"User Object",id:"user-object",level:3},{value:"Tenant Invitation Object",id:"tenant-invitation-object",level:2}];function x(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"tenant-members",children:"Tenant Members"})}),"\n",(0,i.jsx)(n.p,{children:"Tenant Members enable user management operations within the context of a Tenant.\nNew members can be invited via e-mail to join an existing tenant.\nUpon accepting a Tenant Invitation, a new Tenant Member will be created."}),"\n",(0,i.jsx)(n.h2,{id:"list-tenant-members",children:"List Tenant Members"}),"\n",(0,i.jsx)(n.p,{children:"Get a list of Tenant Members for the Tenant."}),"\n",(0,i.jsx)(d.y,{method:d.P.GET,endpoint:"https://api.basistheory.com/tenants/self/members"}),"\n",(0,i.jsx)(n.h4,{id:"permissions",children:"Permissions"}),"\n",(0,i.jsx)(c.a,{content:"tenant:member:read"}),"\n",(0,i.jsx)(n.h3,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(r.A,{className:"bt-tabs",groupId:"languages",children:[(0,i.jsx)(l.A,{value:"shell",label:"cURL",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",metastring:"showLineNumbers",children:'curl "https://api.basistheory.com/tenants/self/members" \\\n -H "BT-API-KEY: <MANAGEMENT_API_KEY>
2"\n'})})}),(0,i.jsx)(l.A,{value:"node",label:"Node",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:"await client.tenants.members.list();\n"})})}),(0,i.jsx)(l.A,{value:"javascript",label:"JavaScript (legacy)",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'import { BasisTheory } from "@basis-theory/basis-theory-js";\n\nconst bt = await new BasisTheory().init("<MANAGEMENT_API_KEY>");\n\nconst tenantMembers = await bt.tenants.listMembers();\n'})})}),(0,i.jsx)(l.A,{value:"csharp",label:"C#",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-csharp",metastring:"showLineNumbers",children:"await client.Tenants.Members.ListAsync(new MembersListRequest());\n"})})}),(0,i.jsx)(l.A,{value:"java",label:"Java",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-java",metastring:"showLineNumbers",children:"new MembersClient(ClientOptions.builder().build()).list();\n"})})}),(0,i.jsx)(l.A,{value:"python",label:"Python",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-python",metastring:"showLineNumbers",children:"client.tenants.members.list()\n"})})}),(0,i.jsx)(l.A,{value:"go",label:"Go",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-go",metastring:"showLineNumber",children:"members, err := client.Tenants.Members.List(ctx, &tenants.MembersListRequest{})\n"})})})]}),"\n",(0,i.jsx)(n.h4,{id:"query-parameters",children:"Query Parameters"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Parameter"}),(0,i.jsx)(n.th,{children:"Required"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Default"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"user_id"})}),(0,i.jsx)(n.td,{children:"false"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"null"})}),(0,i.jsxs)(n.td,{children:["One to many User IDs to query for. Multiple IDs can be passed in the form ",(0,i.jsx)(n.code,{children:"?user_id=<value1>&user_id=<value2>"}),"."]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"page"})}),(0,i.jsx)(n.td,{children:"false"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"integer"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"1"})}),(0,i.jsx)(n.td,{children:"Page number of the results to return."})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"size"})}),(0,i.jsx)(n.td,{children:"false"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"integer"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"20"})}),(0,i.jsx)(n.td,{children:"Number of the results to return per page. Maximum size of 50 results."})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"response",children:"Response"}),"\n",(0,i.jsxs)(n.p,{children:["Returns a ",(0,i.jsx)(n.a,{href:"/docs/api/pagination#offset-pagination-object",children:"paginated object"})," with the ",(0,i.jsx)(n.code,{children:"data"})," property containing an array of ",(0,i.jsx)(n.a,{href:"#tenant-member-object",children:"Tenant Members"}),". Providing any query parameters will filter the results. Returns ",(0,i.jsx)(n.a,{href:"/docs/api/errors",children:"an error"})," if Tenant Members could not be retrieved."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",metastring:"showLineNumbers",children:'{\n "pagination": {...},\n "data": [\n {\n "id": "5540a02f-99e7-46de-8f41-1b3cf7b2a3d2",\n "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",\n "role": "ADMIN",\n "user": {\n "id": "dc5fca8c-dd54-41df-98fc-50d7a1e7fb4d",\n "email": "[email protected]",\n "first_name": "Jane",\n "last_name": "Doe",\n "picture": ""\n },\n "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",\n "created_at": "2020-09-15T15:53:00+00:00",\n "modified_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",\n "modified_at": "2021-03-01T08:23:14+00:00"\n },\n {...},\n {...}\n ]\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"delete-tenant-member",children:"Delete Tenant Member"}),"\n",(0,i.jsx)(n.p,{children:"Delete a Tenant Member by ID from the Tenant. Deleting a Tenant Member will revoke all access from the Tenant."}),"\n",(0,i.jsx)(d.y,{method:d.P.DELETE,endpoint:"https://api.basistheory.com/tenants/self/members/{id}"}),"\n",(0,i.jsx)(n.h4,{id:"permissions-1",children:"Permissions"}
2),"\n",(0,i.jsx)(c.a,{content:"tenant:member:delete"}),"\n",(0,i.jsx)(n.h3,{id:"request-1",children:"Request"}),"\n",(0,i.jsxs)(r.A,{className:"bt-tabs",groupId:"languages",children:[(0,i.jsx)(l.A,{value:"shell",label:"cURL",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",metastring:"showLineNumbers",children:'curl "https://api.basistheory.com/tenants/self/members/5540a02f-99e7-46de-8f41-1b3cf7b2a3d2" \\\n -H "BT-API-KEY: <MANAGEMENT_API_KEY>" \\\n -X "DELETE"\n'})})}),(0,i.jsx)(l.A,{value:"node",label:"Node",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'await client.tenants.members.delete("memberId");\n'})})}),(0,i.jsx)(l.A,{value:"javascript",label:"JavaScript (legacy)",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'import { BasisTheory } from "@basis-theory/basis-theory-js";\n\nconst bt = await new BasisTheory().init("<MANAGEMENT_API_KEY>");\n\nawait bt.tenants.deleteMember("5540a02f-99e7-46de-8f41-1b3cf7b2a3d2");\n'})})}),(0,i.jsx)(l.A,{value:"csharp",label:"C#",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-csharp",metastring:"showLineNumbers",children:'await client.Tenants.Members.DeleteAsync("memberId");\n'})})}),(0,i.jsx)(l.A,{value:"java",label:"Java",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-java",metastring:"showLineNumbers",children:'new MembersClient(ClientOptions.builder().build()).delete("memberId");\n'})})}),(0,i.jsx)(l.A,{value:"python",label:"Python",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-python",metastring:"showLineNumbers",children:'client.tenants.members.delete(\n member_id="memberId",\n)\n'})})}),(0,i.jsx)(l.A,{value:"go",label:"Go",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-go",metastring:"showLineNumbers",children:'err := client.Tenants.Members.Delete(ctx, "memberId")\n'})})})]}),"\n",(0,i.jsx)(n.h4,{id:"uri-parameters",children:"URI Parameters"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Parameter"}),(0,i.jsx)(n.th,{children:"Required"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Default"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"id"})}),(0,i.jsx)(n.td,{children:"true"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"null"})}),(0,i.jsx)(n.td,{children:"The ID of the Tenant Member"})]})})]}),"\n",(0,i.jsx)(n.h3,{id:"response-1",children:"Response"}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.a,{href:"/docs/api/errors",children:"an error"})," if the Tenant Member could not be deleted."]}),"\n",(0,i.jsx)(n.h2,{id:"create-tenant-invitation",children:"Create Tenant Invitation"}),"\n",(0,i.jsx)(n.p,{children:"Invite a new member to join this Tenant. Creating a Tenant Invitation will send an e-mail to the recipient containing a link to accept the invitation."}),"\n",(0,i.jsx)(d.y,{method:d.P.POST,endpoint:"https://api.basistheory.com/tenants/self/invitations"}),"\n",(0,i.jsx)(n.h4,{id:"permissions-2",children:"Permissions"}),"\n",(0,i.jsx)(c.a,{content:"tenant:invitation:create"}),"\n",(0,i.jsx)(n.h3,{id:"request-2",children:"Request"}),"\n",(0,i.jsxs)(r.A,{className:"bt-tabs",groupId:"languages",children:[(0,i.jsx)(l.A,{value:"shell",label:"cURL",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",metastring:"showLineNumbers",children:'curl "https://api.basistheory.com/tenants/self/invitations" \\\n -H "BT-API-KEY: <MANAGEMENT_API_KEY>" \\\n -H "Content-Type: application/json" \\\n -X "POST" \\\n -d \'{\n "email": "[email protected]",\n }\'\n'})})}),(0,i.jsx)(l.A,{value:"node",label:"Node",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'await client.tenants.invitations.create({\n email: "email",\n});\n'})})}),(0,i.jsx)(l.A,{value:"javascript",label:"JavaScript (legacy)",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'import { BasisTheory } from "@basis-theory/basis-theory-js";\n\nconst bt = await new BasisTheory().init("<MANAGEMENT_API_KEY>");\n\nconst createdInvitation = await bt.tenants.createInvitations({\n email: "[email protected]",\n});\n'})})}),(0,i.jsx)(l.A,{value:"csharp",label:"C#",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-csharp",metastring:"showLineNumbers",children:'await client.Tenants.Invitations.CreateAsync(\n new CreateTenantInvitationRequest\n {\n Email = "email"\n }\n);\n'})})}),(0,i.jsx)(l.A,{value:"java",label:"Java",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-java",metastring:"showLineNumbers",children:'new InvitationsClient(ClientOptions.builder().build()).create(CreateTenantInvitationRequest.builder()\n .email("[email protected]")\n .role("ADMIN")\n .build());\n'})})}),(0,i.jsx)(l.A,{value:"python",label:"Python",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-python",metastring:"showLineNumbers",children:'client.tenants.invitations.create(\n email="email",\n)\n'})})}),(0,i.jsx)(l.A,{value:"go",label:"Go",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-go",metastring:"showLineNumbers",children:'invitation, err := client.Tenants.Invitations.Create(ctx, &tenants.CreateTenantInvitationRequest{\n\tEmail: "[email protected]",\n})\n'})})})]}),"\n",(0,i.jsx)(n.h4,{id:"request-parameters",children:"Request Parameters"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Attribute"}),(0,i.jsx)(n.th,{children:"Required"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Default"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"email"})}),(0,i.jsx)(n.td,{children:"true"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"string"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"null"})}),(0,i.jsxs)(n.td,{children:["The invitee's e-mail address. Has to be a well-formed e-mail address (",(0,i.jsx)(n.a,{href:"https://datatracker.ietf.org/doc/html/rfc5322",children:"RFC 5322"}),")."]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"role"})}),(0,i.jsx)(n.td,{children:"false"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"string"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"ADMIN"})}),(0,i.jsxs)(n.td,{children:["The invitee's role once accepted. Valid values: ",(0,i.jsx)(n.code,{children:"ADMIN"})," or ",(0,i.jsx)(n.code,{children:"READ_ONLY"})]})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"response-2",children:"Response"}),"\n",(0,i.jsxs)(n.p,{children:["Returns a ",(0,i.jsx)(n.a,{href:"#tenant-invitation-object",children:"Tenant Invitation"})," if the Tenant Invitation was created. Returns ",(0,i.jsx)(n.a,{href:"/docs/api/errors",children:"an error"})," if there were validation errors, or the Tenant Invitation failed to create."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",metastring:"showLineNumbers",children:'{\n "id": "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13",\n "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",\n "email": "[email protected]",\n "status": "PENDING",\n "expires_at": "2020-09-18T15:53:00+00:00",\n "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",\n "created_at": "2020-09-15T15:53:00+00:00"\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"resend-tenant-invitation",children:"Resend Tenant Invitation"}
2),"\n",(0,i.jsx)(n.p,{children:"Resend a pending or expired Tenant Invitation. Resending the invitation will extend the expiration by 72 hours and invalidate any previous invitation link(s) sent to the recipient."}),"\n",(0,i.jsx)(d.y,{method:d.P.POST,endpoint:"https://api.basistheory.com/tenants/self/invitations/{id}/resend"}),"\n",(0,i.jsx)(n.h4,{id:"permissions-3",children:"Permissions"}),"\n",(0,i.jsx)(c.a,{content:"tenant:invitation:create"}),"\n",(0,i.jsx)(c.a,{content:"tenant:invitation:update"}),"\n",(0,i.jsx)(n.h3,{id:"request-3",children:"Request"}),"\n",(0,i.jsxs)(r.A,{className:"bt-tabs",groupId:"languages",children:[(0,i.jsx)(l.A,{value:"shell",label:"cURL",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",metastring:"showLineNumbers",children:'curl "https://api.basistheory.com/tenants/self/invitations/fb32ea26-2185-4ad2-a7bf-2fe69c00ae13/resend" \\\n -H "BT-API-KEY: <MANAGEMENT_API_KEY>" \\\n -H "Content-Type: application/json" \\\n -X "POST"\n'})})}),(0,i.jsx)(l.A,{value:"node",label:"Node",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'await client.tenants.invitations.resend("invitationId");\n'})})}),(0,i.jsx)(l.A,{value:"javascript",label:"JavaScript (legacy)",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'import { BasisTheory } from "@basis-theory/basis-theory-js";\n\nconst bt = await new BasisTheory().init("<MANAGEMENT_API_KEY>");\n\nconst resentInvitation = await bt.tenants.resendInvitation(\n "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13"\n);\n'})})}),(0,i.jsx)(l.A,{value:"csharp",label:"C#",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-csharp",metastring:"showLineNumbers",children:'await client.Tenants.Invitations.ResendAsync("invitationId");\n'})})}),(0,i.jsx)(l.A,{value:"java",label:"Java",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-java",metastring:"showLineNumbers",children:'new InvitationsClient(ClientOptions.builder().build()).resend("invitationId");\n'})})}),(0,i.jsx)(l.A,{value:"python",label:"Python",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-python",metastring:"showLineNumbers",children:'client.tenants.invitations.resend(\n invitation_id="invitationId",\n)\n'})})}),(0,i.jsx)(l.A,{value:"go",label:"Go",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-go",metastring:"showLineNumbers",children:'invitation, err := client.Tenants.Invitations.Resend(ctx, "invitationId")\n'})})})]}),"\n",(0,i.jsx)(n.h4,{id:"uri-parameters-1",children:"URI Parameters"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Parameter"}),(0,i.jsx)(n.th,{children:"Required"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Default"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"id"})}),(0,i.jsx)(n.td,{children:"true"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"null"})}),(0,i.jsx)(n.td,{children:"The ID of the Tenant Invitation"})]})})]}),"\n",(0,i.jsx)(n.h3,{id:"response-3",children:"Response"}),"\n",(0,i.jsxs)(n.p,{children:["Returns a ",(0,i.jsx)(n.a,{href:"#tenant-invitation-object",children:"Tenant Invitation"})," if the Tenant Invitation was resent. Returns ",(0,i.jsx)(n.a,{href:"/docs/api/errors",children:"an error"})," if there were validation errors, or the Tenant Invitation failed to resend."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",metastring:"showLineNumbers",children:'{\n "id": "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13",\n "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",\n "email": "[email protected]",\n "status": "PENDING",\n "expires_at": "2020-09-18T15:53:00+00:00",\n "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",\n "created_at": "2020-09-15T15:53:00+00:00"\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"list-tenant-invitations",children:"List Tenant Invitations"}),"\n",(0,i.jsx)(n.p,{children:"Get a list of Tenant Invitations for the Tenant."}),"\n",(0,i.jsx)(d.y,{method:d.P.GET,endpoint:"https://api.basistheory.com/tenants/self/invitations"}),"\n",(0,i.jsx)(n.h4,{id:"permissions-4",children:"Permissions"}),"\n",(0,i.jsx)(c.a,{content:"tenant:invitation:read"}),"\n",(0,i.jsx)(n.h3,{id:"request-4",children:"Request"}),"\n",(0,i.jsxs)(r.A,{className:"bt-tabs",groupId:"languages",children:[(0,i.jsx)(l.A,{value:"shell",label:"cURL",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",metastring:"showLineNumbers",children:'curl "https://api.basistheory.com/tenants/self/invitations" \\\n -H "BT-API-KEY: <MANAGEMENT_API_KEY>
2"\n'})})}),(0,i.jsx)(l.A,{value:"node",label:"Node",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:"const response = await client.tenants.invitations.list();\nfor await (const item of response) {\n console.log(item);\n}\n\n// Or you can manually iterate page-by-page\nconst page = await client.tenants.invitations.list();\nwhile (page.hasNextPage()) {\n page = page.getNextPage();\n}\n"})})}),(0,i.jsx)(l.A,{value:"javascript",label:"JavaScript (legacy)",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'import { BasisTheory } from "@basis-theory/basis-theory-js";\n\nconst bt = await new BasisTheory().init("<MANAGEMENT_API_KEY>");\n\nconst invitations = await bt.tenants.listInvitations();\n'})})}),(0,i.jsx)(l.A,{value:"csharp",label:"C#",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-csharp",metastring:"showLineNumbers",children:"await client.Tenants.Invitations.ListAsync(new InvitationsListRequest());\n"})})}),(0,i.jsx)(l.A,{value:"java",label:"Java",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-java",metastring:"showLineNumbers",children:"new InvitationsClient(ClientOptions.builder().build()).list();\n"})})}),(0,i.jsx)(l.A,{value:"python",label:"Python",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-python",metastring:"showLineNumbers",children:"response = client.tenants.invitations.list()\n\nfor item in response:\n yield item\n\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n yield page\n"})})}),(0,i.jsx)(l.A,{value:"go",label:"Go",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-go",metastring:"showLineNumbers",children:"invitations, err := client.Tenants.Invitations.List(ctx, &tenants.InvitationsListRequest{})\n"})})})]}),"\n",(0,i.jsx)(n.h4,{id:"query-parameters-1",children:"Query Parameters"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Parameter"}),(0,i.jsx)(n.th,{children:"Required"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Default"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"page"})}),(0,i.jsx)(n.td,{children:"false"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"integer"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"1"})}),(0,i.jsx)(n.td,{children:"Page number of the results to return."})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"size"})}),(0,i.jsx)(n.td,{children:"false"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"integer"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"20"})}),(0,i.jsx)(n.td,{children:"Number of the results to return per page. Maximum size of 100 results."})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"response-4",children:"Response"}),"\n",(0,i.jsxs)(n.p,{children:["Returns a ",(0,i.jsx)(n.a,{href:"/docs/api/pagination#offset-pagination-object",children:"paginated object"})," with the ",(0,i.jsx)(n.code,{children:"data"})," property containing an array of ",(0,i.jsx)(n.a,{href:"#tenant-invitation-object",children:"Tenant Invitations"}),".\nProviding any query parameters will filter the results.\nReturns ",(0,i.jsx)(n.a,{href:"/docs/api/errors",children:"an error"})," if Tenant Invitations could not be retrieved."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",metastring:"showLineNumbers",children:'{\n "pagination": {...},\n "data": [\n {\n "id": "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13",\n "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",\n "email": "[email protected]",\n "status": "PENDING",\n "expires_at": "2020-09-18T15:53:00+00:00",\n "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",\n "created_at": "2020-09-15T15:53:00+00:00"\n },\n {...},\n {...}\n ]\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"get-a-tenant-invitation",children:"Get a Tenant Invitation"}),"\n",(0,i.jsx)(n.p,{children:"Get a Tenant Invitation by ID in the Tenant."}),"\n",(0,i.jsx)(d.y,{method:d.P.GET,endpoint:"https://api.basistheory.com/tenants/self/invitations/{id}"}),"\n",(0,i.jsx)(n.h4,{id:"permissions-5",children:"Permissions"}),"\n",(0,i.jsx)(c.a,{content:"tenant:invitation:read"}),"\n",(0,i.jsx)(n.h3,{id:"request-5",children:"Request"}),"\n",(0,i.jsxs)(r.A,{className:"bt-tabs",groupId:"languages",children:[(0,i.jsx)(l.A,{value:"shell",label:"cURL",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",metastring:"showLineNumbers",children:'curl "https://api.basistheory.com/tenants/self/invitations/fb32ea26-2185-4ad2-a7bf-2fe69c00ae13" \\\n -H "BT-API-KEY: <MANAGEMENT_API_KEY>
2"\n'})})}),(0,i.jsx)(l.A,{value:"node",label:"Node",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'await client.tenants.invitations.get("invitationId");\n'})})}),(0,i.jsx)(l.A,{value:"javascript",label:"JavaScript (legacy)",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'import { BasisTheory } from "@basis-theory/basis-theory-js";\n\nconst bt = await new BasisTheory().init("<MANAGEMENT_API_KEY>");\n\nconst invitation = await bt.tenants.retrieveInvitation(\n "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13"\n);\n'})})}),(0,i.jsx)(l.A,{value:"csharp",label:"C#",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-csharp",metastring:"showLineNumbers",children:'await client.Tenants.Invitations.GetAsync("invitationId");\n'})})}),(0,i.jsx)(l.A,{value:"java",label:"Java",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-java",metastring:"showLineNumbers",children:'new InvitationsClient(ClientOptions.builder().build()).get("invitationId");\n'})})}),(0,i.jsx)(l.A,{value:"python",label:"Python",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-python",metastring:"showLineNumbers",children:'client.tenants.invitations.get(\n invitation_id="invitationId",\n)\n'})})}),(0,i.jsx)(l.A,{value:"go",label:"Go",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-go",metastring:"showLineNumbers",children:'invitation, err := client.Tenants.Invitations.Get(ctx, "invitationId")\n'})})})]}),"\n",(0,i.jsx)(n.h4,{id:"uri-parameters-2",children:"URI Parameters"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Parameter"}),(0,i.jsx)(n.th,{children:"Required"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Default"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"id"})}),(0,i.jsx)(n.td,{children:"true"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"null"})}),(0,i.jsx)(n.td,{children:"The ID of the Tenant Invitation"})]})})]}),"\n",(0,i.jsx)(n.h3,{id:"response-5",children:"Response"}),"\n",(0,i.jsxs)(n.p,{children:["Returns a ",(0,i.jsx)(n.a,{href:"#tenant-invitation-object",children:"Tenant Invitation"})," with the ",(0,i.jsx)(n.code,{children:"id"})," provided. Returns ",(0,i.jsx)(n.a,{href:"/docs/api/errors",children:"an error"})," if the Tenant Invitation could not be retrieved."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",metastring:"showLineNumbers",children:'{\n "id": "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13",\n "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",\n "email": "[email protected]",\n "status": "PENDING",\n "expires_at": "2020-09-18T15:53:00+00:00",\n "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",\n "created_at": "2020-09-15T15:53:00+00:00"\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"delete-tenant-invitation",children:"Delete Tenant Invitation"}),"\n",(0,i.jsx)(n.p,{children:"Delete a Tenant Invitation by ID from the Tenant. Deleting a Tenant Invitation will invalidate any outstanding invitation links sent to the recipient."}),"\n",(0,i.jsx)(d.y,{method:d.P.DELETE,endpoint:"https://api.basistheory.com/tenants/self/invitations/{id}"}),"\n",(0,i.jsx)(n.h4,{id:"permissions-6",children:"Permissions"}),"\n",(0,i.jsx)(c.a,{content:"tenant:invitation:delete"}),"\n",(0,i.jsx)(n.h3,{id:"request-6",children:"Request"}),"\n",(0,i.jsxs)(r.A,{className:"bt-tabs",groupId:"languages",children:[(0,i.jsx)(l.A,{value:"shell",label:"cURL",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",metastring:"showLineNumbers",children:'curl "https://api.basistheory.com/tenants/self/invitations/fb32ea26-2185-4ad2-a7bf-2fe69c00ae13" \\\n -H "BT-API-KEY: <MANAGEMENT_API_KEY>" \\\n -X "DELETE"\n'})})}),(0,i.jsx)(l.A,{value:"node",label:"Node",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'await client.tenants.invitations.delete("invitationId");\n'})})}),(0,i.jsx)(l.A,{value:"javascript",label:"JavaScript (legacy)",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",metastring:"showLineNumbers",children:'import { BasisTheory } from "@basis-theory/basis-theory-js";\n\nconst bt = await new BasisTheory().init("<MANAGEMENT_API_KEY>");\n\nawait bt.tenants.deleteInvitation("fb32ea26-2185-4ad2-a7bf-2fe69c00ae13");\n'})})}),(0,i.jsx)(l.A,{value:"csharp",label:"C#",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-csharp",metastring:"showLineNumbers",children:'await client.Tenants.Invitations.DeleteAsync("invitationId");\n'})})}),(0,i.jsx)(l.A,{value:"java",label:"Java",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-java",metastring:"showLineNumbers",children:'new InvitationsClient(ClientOptions.builder().build()).delete("invitationId");\n'})})}),(0,i.jsx)(l.A,{value:"python",label:"Python",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-python",metastring:"showLineNumbers",children:'client.tenants.invitations.delete(\n invitation_id="invitationId",\n)\n'})})}),(0,i.jsx)(l.A,{value:"go",label:"Go",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-go",metastring:"showLineNumbers",children:'err := client.Tenants.Invitations.Delete(ctx, "invitationId")\n'})})})]}),"\n",(0,i.jsx)(n.h4,{id:"uri-parameters-3",children:"URI Parameters"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Parameter"}),(0,i.jsx)(n.th,{children:"Required"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Default"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"id"})}),(0,i.jsx)(n.td,{children:"true"}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"null"})}),(0,i.jsx)(n.td,{children:"The ID of the Tenant Invitation"})]})})]}),"\n",(0,i.jsx)(n.h3,{id:"response-6",children:"Response"}),"\n",(0,i.jsxs)(n.p,{children:["Returns ",(0,i.jsx)(n.a,{href:"/docs/api/errors",children:"an error"})," if the Tenant Invitation could not be deleted."]}),"\n",(0,i.jsx)(n.h2,{id:"tenant-member-object",children:"Tenant Member Object"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Attribute"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"id"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsx)(n.td,{children:"Unique identifier of the Tenant Member"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"tenant_id"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsxs)(n.td,{children:["The ",(0,i.jsx)(n.a,{href:"/docs/api/tenants#tenant-object",children:"Tenant"})," ID that the membership is attached"]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"role"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"string"})}),(0,i.jsxs)(n.td,{children:["The ",(0,i.jsx)(n.a,{href:"#roles",children:"Role"})," assigned to the Tenant Member"]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"user"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:(0,i.jsx)(n.a,{href:"#user-object",children:"user object"})})}),(0,i.jsx)(n.td,{children:"The User which this membership is attached to"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"created_by"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsxs)(n.td,{children:["(Optional) The ID of the User or ",(0,i.jsx)(n.a,{href:"/docs/api/applications",children:"Application"})," that created the Tenant Member"]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"created_at"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"date"})}),(0,i.jsx)(n.td,{children:"(Optional) Created date of the Tenant Member in ISO 8601 format"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"modified_by"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsxs)(n.td,{children:["(Optional) The ID of the User or ",(0,i.jsx)(n.a,{href:"/docs/api/applications",children:"Application"})," that last modified the Tenant Member"]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"modified_at"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"date"})}),(0,i.jsx)(n.td,{children:"(Optional) Last modified date of the Tenant Member in ISO 8601 format"})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"roles",children:"Roles"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Role"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"OWNER"})}),(0,i.jsxs)(n.td,{children:["The ",(0,i.jsx)(n.code,{children:"OWNER"})," role is automatically assigned to the Tenant Owner and grants full access to all features. The Tenant ",(0,i.jsx)(n.code,{children:"OWNER"})," cannot be deleted."]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"ADMIN"})}),(0,i.jsxs)(n.td,{children:["The ",(0,i.jsx)(n.code,{children:"ADMIN"})," role is assigned by default to all members and grants full access to all features."]})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"user-object",children:"User Object"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Attribute"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"id"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsx)(n.td,{children:"Unique identifier of the User"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"email"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"string"})}),(0,i.jsx)(n.td,{children:"(Optional) The e-mail address of the User"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"first_name"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"string"})}),(0,i.jsx)(n.td,{children:"(Optional) The User's first name"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"last_name"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"string"})}),(0,i.jsx)(n.td,{children:"(Optional) The User's last name"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"picture"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"string"})}),(0,i.jsx)(n.td,{children:"(Optional) A URI pointing to the User's picture"})]})]})]}),"\n",(0,i.jsx)(n.h2,{id:"tenant-invitation-object",children:"Tenant Invitation Object"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Attribute"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"id"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsx)(n.td,{children:"Unique identifier of the Tenant Invitation"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"tenant_id"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsxs)(n.td,{children:["The ",(0,i.jsx)(n.a,{href:"/docs/api/tenants#tenant-object",children:"Tenant"})," ID that the invitation is tied to. When the invitation is accepted, a new Tenant Member will be created in this Tenant."]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"email"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"string"})}),(0,i.jsx)(n.td,{children:"The invitee's e-mail address"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"status"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"string"})}),(0,i.jsxs)(n.td,{children:["The status of the invitation (i.e. ",(0,i.jsx)(n.code,{children:"PENDING"})," or ",(0,i.jsx)(n.code,{children:"EXPIRED"}),")"]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"expires_at"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"date"})}),(0,i.jsx)(n.td,{children:"The expiration date of the invitation is ISO 8601 format. By default, the invitation expires 72 hours from the time it was created. Invitations can be resent to extend the expiration, but doing so will invalidate the previous invitation link sent to the invitee."})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"created_by"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsxs)(n.td,{children:["(Optional) The ID of the User or ",(0,i.jsx)(n.a,{href:"/docs/api/applications",children:"Application"})," that created the Tenant Invitation"]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"created_at"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"date"})}),(0,i.jsx)(n.td,{children:"(Optional) Created date of the Tenant Invitation in ISO 8601 format"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"modified_by"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"uuid"})}),(0,i.jsxs)(n.td,{children:["(Optional) The ID of the User or ",(0,i.jsx)(n.a,{href:"/docs/api/applications",children:"Application"})," that last modified the Tenant Invitation"]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"modified_at"})}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.em,{children:"date"})}),(0,i.jsx)(n.td,{children:"(Optional) Last modified date of the Tenant Invitation in ISO 8601 format"})]})]})]})]})}function m(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(x,{...e})}):x(e)}},21020:(e,n,t)=>{var s=t(96540),i=Symbol.for("react.element"),a=Symbol.for("react.fragment"),r=Object.prototype.hasOwnProperty,l=s.__SECRET_INT
2ERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,d={key:!0,ref:!0,__self:!0,__source:!0};function c(e,n,t){var s,a={},c=null,o=null;for(s in void 0!==t&&(c=""+t),void 0!==n.key&&(c=""+n.key),void 0!==n.ref&&(o=n.ref),n)r.call(n,s)&&!d.hasOwnProperty(s)&&(a[s]=n[s]);if(e&&e.defaultProps)for(s in n=e.defaultProps)void 0===a[s]&&(a[s]=n[s]);return{$$typeof:i,type:e,key:c,ref:o,props:a,_owner:l.current}}n.Fragment=a,n.jsx=c,n.jsxs=c},74848:(e,n,t)=>{e.exports=t(21020)},83227:(e,n,t)=>{t.d(n,{A:()=>r});var s=t(96540),i=t(34164);const a={tabItem:"tabItem_Ymn6"};function r({children:e,hidden:n,className:t}){return s.createElement("div",{role:"tabpanel",className:(0,i.A)(a.tabItem,t),hidden:n},e)}},13187:(e,n,t)=>{t.d(n,{A:()=>A});var s=t(96540),i=t(34164),a=t(23575),r=t(56347),l=t(91648),d=t(62072),c=t(73353),o=t(85831);function h(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function j(e,n){return n=null!=n?n:{},Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):function(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);n&&(s=s.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,s)}return t}(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))})),e}function u(e){var n,t;return null!==(t=null===(n=s.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,s.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad <Tabs> child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`)}
2)))||void 0===n?void 0:n.filter(Boolean))&&void 0!==t?t:[]}function x(e){const{values:n,children:t}=e;return(0,s.useMemo)((()=>{const e=null!=n?n:function(e){return u(e).map((({props:{value:e,label:n,attributes:t,default:s}})=>({value:e,label:n,attributes:t,default:s})))}(t);return function(e){const n=(0,c.XI)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in <Tabs>. Every value needs to be unique.`)}(e),e}),[n,t])}function m({value:e,tabValues:n}){return n.some((n=>n.value===e))}function p({queryString:e=!1,groupId:n}){const t=(0,r.W6)(),i=function({queryString:e=!1,groupId:n}){if("string"==typeof e)return e;if(!1===e)return null;if(!0===e&&!n)throw new Error('Docusaurus error: The <Tabs> component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return null!=n?n:null}({queryString:e,groupId:n}),a=(0,d.aZ)(i),l=(0,s.useCallback)((e=>{if(!i)return;const n=new URLSearchParams(t.location.search);n.set(i,e),t.replace(j(function(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{},s=Object.keys(t);"function"==typeof Object.getOwnPropertySymbols&&(s=s.concat(Object.getOwnPropertySymbols(t).filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable})))),s.forEach((function(n){h(e,n,t[n])}))}return e}({},t.location),{search:n.toString()}))}),[i,t]);return[a,l]}function b(e){const{defaultValue:n,queryString:t=!1,groupId:i}
2=e,a=x(e),[r,d]=(0,s.useState)((()=>function({defaultValue:e,tabValues:n}){if(0===n.length)throw new Error("Docusaurus error: the <Tabs> component requires at least one <TabItem> children component");if(e){if(!m({value:e,tabValues:n}))throw new Error(`Docusaurus error: The <Tabs> has a defaultValue "${e}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return e}var t;const s=null!==(t=n.find((e=>e.default)))&&void 0!==t?t:n[0];if(!s)throw new Error("Unexpected error: 0 tabValues");return s.value}({defaultValue:n,tabValues:a}))),[c,h]=p({queryString:t,groupId:i}),[j,u]=function({groupId:e}){const n=function(e){return e?`docusaurus.tab.${e}`:null}(e),[t,i]=(0,o.Dv)(n);return[t,(0,s.useCallback)((e=>{n&&i.set(e)}),[n,i])]}({groupId:i}),b=(()=>{const e=null!=c?c:j;return m({value:e,tabValues:a})?e:null})();(0,l.A)((()=>{b&&d(b)}),[b]);return{selectedValue:r,selectValue:(0,s.useCallback)((e=>{if(!m({value:e,tabValues:a}))throw new Error(`Can't select invalid tab value=${e}`);d(e),h(e),u(e)}),[h,u,a]),tabValues:a}}var v=t(52700);const f={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function g(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function y(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{},s=Object.keys(t);"function"==typeof Object.getOwnPropertySymbols&&(s=s.concat(Object.getOwnPropertySymbols(t).filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable})))),s.forEach((function(n){g(e,n,t[n])}))}return e}function T(e,n){return n=null!=n?n:{},Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):function(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);n&&(s=s.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,s)}return t}(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))})),e}function N({className:e,block:n,selectedValue:t,selectValue:r,tabValues:l}){const d=[],{blockElementScrollPositionUntilNextRender:c}=(0,a.a_)(),o=e=>{const n=e.currentTarget,s=d.indexOf(n),i=l[s].value;i!==t&&(c(n),r(i))},h=e=>{let n=null;switch(e.key){case"Enter":o(e);break;case"ArrowRight":{const s=d.indexOf(e.currentTarget)+1;var t;n=null!==(t=d[s])&&void 0!==t?t:d[0];break}case"ArrowLeft":{const t=d.indexOf(e.currentTarget)-1;var s;n=null!==(s=d[t])&&void 0!==s?s:d[d.length-1];break}}null==n||n.focus()};return s.createElement("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,i.A)("tabs",{"tabs--block":n},e)},l.map((({value:e,label:n,attributes:a})=>s.createElement("li",T(y({role:"tab",tabIndex:t===e?0:-1,"aria-selected":t===e,key:e,ref:e=>{d.push(e)},onKeyDown:h,onClick:o},a),{className:(0,i.A)("tabs__item",f.tabItem,null==a?void 0:a.className,{"tabs__item--active":t===e})}),null!=n?n:e))))}function w({lazy:e,children:n,selectedValue:t}){const a=(Array.isArray(n)?n:[n]).filter(Boolean);if(e){const e=a.find((e=>e.props.value===t));return e?(0,s.cloneElement)(e,{className:(0,i.A)("margin-top--md",e.props.className)}):null}return s.createElement("div",{className:"margin-top--md"},a.map(((e,n)=>(0,s.cloneElement)(e,{key:n,hidden:e.props.value!==t}))))}function I(e){const n=b(e);return s.createElement("div",{className:(0,i.A)("tabs-container",f.tabList)},s.createElement(N,y({},n,e)),s.createElement(w,y({},n,e)))}function A(e){const n=(0,v.A)();return s.createElement(I,y({key:String(n)},e),u(e.children))}},47363:(e,n,t)=>{t.d(n,{y:()=>x,P:()=>u});var s=t(34164),i=t(96540);const a="container_do9A",r="get_oO0z",l="post_VGoy",d="put_yXVr",c="patch_mtMM",o="delete_tJlc",h="copy_R9HH";var j=t(78534);var u=function(e){return e.POST="POST",e.PUT="PUT",e.DELETE="DELETE",e.GET="GET",e.PATCH="PATCH",e}({});const x=({method:e,endpoint:n})=>{const[t,u]=(0,i.useState)(!1),x=(0,s.A)({[l]:"POST"==e,[d]:"PUT"==e,[o]:"DELETE"==e,[r]:"GET"==e,[c]:"PATCH"==e});(0,i.useEffect)((()=>{t&&setTimeout((()=>{u(!1)}),1e3)}),[t]);return i.createElement("div",{className:(0,s.A)(a)},i.createElement(j.a,{className:x},e)," ",n,i.createElement("div",{className:h,onClick:e=>{u(!0),(async e=>{"clipboard"in navigator?await navigator.clipboard.writeText(e):document.execCommand("copy",!0,e)})(n)}},t?i.createElement("svg",{width:"24",height:"18",viewBox:"0 0 18 18",fill:"#00d600"},i.createElement("path",{d:"M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"})):i.createElement("svg",{width:"18",height:"18",viewBox:"0 0 18 18",fill:"none",xmlns:"http://www.w3.org/2000/svg"},i.createElement("title",null,"Copy"),i.createElement("path",{fillRule:"evenodd",clipRule:"evenodd",d:"M4.16488 3.31632C3.9398 3.31632 3.72395 3.40573 3.56479 3.56489C3.40564 3.72404 3.31623 3.9399 3.31623 4.16497V11.0726C3.31623 11.2976 3.40564 11.5135 3.56479 11.6726C3.72395 11.8318 3.9398 11.9212 4.16488 11.9212H5.01353V6.92801C5.01353 5.87072 5.87063 5.01362 6.92792 5.01362H11.9211V4.16497C11.9211 3.9399 11.8317 3.72404 11.6726 3.56489C11.5134 3.40573 11.2975 3.31632 11.0725 3.31632H4.16488ZM12.9869 5.01362V4.16497C12.9869 3.65724 12.7852 3.17031 12.4262 2.81129C12.0671 2.45227 11.5802 2.25058 11.0725 2.25058H4.16488C3.65715 2.25058 3.17022 2.45227 2.8112 2.81129C2.45218 3.17031 2.25049 3.65724 2.25049 4.16497V11.0726C2.25049 11.5803 2.45218 12.0672 2.8112 12.4262C3.17022 12.7853 3.65715 12.987 4.16488 12.987H5.01353V13.8356C5.01353 14.8929 5.87063 15.75 6.92792 15.75H13.8355C14.8928 15.75 15.7499 14.8929 15.7499 13.8356V6.92801C15.7499 5.87072 14.8928 5.01362 13.8355 5.01362H12.9869ZM12.4533 6.07936C12.4535 6.07936 12.4538 6.07936 12.454 6.07936C12.4542 6.07936 12.4544 6.07936 12.4547 6.07936H13.8355C14.3042 6.07936 14.6842 6.45931 14.6842 6.92801V13.8356C14.6842 14.3043 14.3042 14.6842 13.8355 14.6842H6.92792C6.45922 14.6842 6.07927 14.3043 6.07927 13.8356V12.4548C6.07927 12.4545 6.07927 12.4543 6.07927 12.4541C6.07927 12.4539 6.07927 12.4536 6.07927 12.4534V6.92801C6.07927 6.45931 6.45922 6.07936 6.92792 6.07936H12.4533Z",fill:"currentColor"}))))}},2368:(e,n,t)=>{t.d(n,{a:()=>l});var s=t(34164),i=t(96540);const a="primary_vpwI",r="secondary_eVSP",l=({content:e,variant:n="secondary",children:t})=>{const l=(0,s.A)({[a]:"primary"==n,[r]:"secondary"==n}
2);return i.createElement("code",{className:l},null!=e?e:t)}},78534:(e,n,t)=>{t.d(n,{a:()=>l});var s=t(96540);const i="pill_KJZw",a="pill-container_xPdd";var r=t(34164);const l=({children:e,className:n,title:t})=>s.createElement("div",{className:(0,r.A)(a)},s.createElement("span",{className:(0,r.A)(i,n),title:t},e))},28453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>l});var s=t(96540);const i={},a=s.createContext(i);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(a.Provider,{value:n},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.