> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/app-maker-open-apis/profile/user-access-token.md). # User Access Token Manage user access tokens. ## Get user access tokens > Get user access tokens by me (logged in user) ```json {"openapi":"3.0.3","info":{"title":"AppMaker API - OAS 3.0","version":"1.0.0"},"tags":[{"name":"me","description":"Endpoints for the authenticated user."},{"name":"user-access-token","description":"Manage user access tokens."}],"servers":[{"url":"https://abp-api.akinon.net/api/v1","description":"Production server"},{"url":"https://abptest-api.akinon.net/api/v1","description":"Test server"},{"url":"http://localhost:5001/api/v1","description":"Local server"}],"security":[{"bearerAuth":[]},{"accessToken":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"accessToken":{"type":"apiKey","in":"header","name":"x-access-token"}},"responses":{"GetUserAccessTokensResponse":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/UserAccessToken"},{"type":"object"}],"properties":{"token":{"type":"string","description":"Masked access token value"},"organization":{"$ref":"#/components/schemas/Organization"}}}}]}}}},"UnauthorizedErrorResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"ForbiddenErrorResponse":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}}},"schemas":{"UserAccessToken":{"type":"object","required":["name","token","expiresOn","privileges","userId","organizationId"],"properties":{"_id":{"$ref":"#/components/schemas/ReadOnlyMongoId"},"name":{"type":"string","description":"Access token name"},"token":{"type":"string","description":"Access token value"},"privileges":{"type":"array","items":{"type":"string","description":"Access token privileges formatted as (:)"},"description":"Access token privileges"},"userId":{"$ref":"#/components/schemas/MongoId"},"organizationId":{"$ref":"#/components/schemas/MongoId"},"expiresOn":{"$ref":"#/components/schemas/ReadOnlyDate"},"createdAt":{"$ref":"#/components/schemas/ReadOnlyDate"},"updatedAt":{"$ref":"#/components/schemas/ReadOnlyDate"}}},"ReadOnlyMongoId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"Entity ID","readOnly":true},"MongoId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"Entity ID"},"ReadOnlyDate":{"type":"string","format":"date-time","readOnly":true,"description":"Date"},"Organization":{"type":"object","required":["_id","name","slug","description","owner","isExecutive","status","privileges"],"properties":{"_id":{"$ref":"#/components/schemas/MongoId"},"name":{"type":"string","minLength":2,"maxLength":100,"description":"Organization name"},"slug":{"$ref":"#/components/schemas/Slug"},"description":{"type":"string","minLength":2,"maxLength":255,"description":"Organization description"},"owner":{"$ref":"#/components/schemas/MongoId"},"isExecutive":{"type":"boolean","description":"Organization is executive","default":false,"readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"privileges":{"type":"array","items":{"type":"string"},"description":"Organization privileges, formatted as (:)","default":[]},"imageUrl":{"type":"string","description":"Organization image URL"},"createdAt":{"$ref":"#/components/schemas/ReadOnlyDate"},"updatedAt":{"$ref":"#/components/schemas/ReadOnlyDate"}}},"Slug":{"type":"string","pattern":"^[a-z0-9-]{2,100}$","minLength":2,"maxLength":100,"description":"Slug"},"Status":{"type":"integer","description":"Status","enum":[0,1]},"UnauthorizedError":{"type":"object","properties":{"apiError":{"type":"array","items":{"type":"string"},"description":"Error message"}}},"ForbiddenError":{"type":"object","properties":{"apiError":{"type":"array","items":{"type":"string"},"description":"Error message"}}}}},"paths":{"/me/tokens":{"get":{"tags":["user-access-token","me"],"summary":"Get user access tokens","description":"Get user access tokens by me (logged in user)","operationId":"getUserAccessTokens","responses":{"200":{"$ref":"#/components/responses/GetUserAccessTokensResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"}}}}}} ``` ## Create a user access token > Create a user access token by me (logged in user) ```json {"openapi":"3.0.3","info":{"title":"AppMaker API - OAS 3.0","version":"1.0.0"},"tags":[{"name":"me","description":"Endpoints for the authenticated user."},{"name":"user-access-token","description":"Manage user access tokens."}],"servers":[{"url":"https://abp-api.akinon.net/api/v1","description":"Production server"},{"url":"https://abptest-api.akinon.net/api/v1","description":"Test server"},{"url":"http://localhost:5001/api/v1","description":"Local server"}],"security":[{"bearerAuth":[]},{"accessToken":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"accessToken":{"type":"apiKey","in":"header","name":"x-access-token"}},"requestBodies":{"CreateUserAccessTokenRequest":{"required":true,"content":{"application/json":{"schema":{"required":["name","lifetime"],"properties":{"name":{"type":"string","description":"Access token name"},"lifetime":{"type":"string","description":"Token lifetime","enum":["one-week","one-month","three-months","six-months","one-year"]},"privileges":{"type":"array","items":{"type":"string","description":"Token privileges"}}}}}}}},"responses":{"CreateUserAccessTokenResponse":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccessToken"}}}},"GenericErrorResponse":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"validationError":{"type":"object","properties":{}},"apiError":{"type":"array","items":{}}}}}}}},"schemas":{"UserAccessToken":{"type":"object","required":["name","token","expiresOn","privileges","userId","organizationId"],"properties":{"_id":{"$ref":"#/components/schemas/ReadOnlyMongoId"},"name":{"type":"string","description":"Access token name"},"token":{"type":"string","description":"Access token value"},"privileges":{"type":"array","items":{"type":"string","description":"Access token privileges formatted as (:)"},"description":"Access token privileges"},"userId":{"$ref":"#/components/schemas/MongoId"},"organizationId":{"$ref":"#/components/schemas/MongoId"},"expiresOn":{"$ref":"#/components/schemas/ReadOnlyDate"},"createdAt":{"$ref":"#/components/schemas/ReadOnlyDate"},"updatedAt":{"$ref":"#/components/schemas/ReadOnlyDate"}}},"ReadOnlyMongoId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"Entity ID","readOnly":true},"MongoId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"Entity ID"},"ReadOnlyDate":{"type":"string","format":"date-time","readOnly":true,"description":"Date"}}},"paths":{"/me/tokens":{"post":{"tags":["user-access-token","me"],"summary":"Create a user access token","description":"Create a user access token by me (logged in user)","operationId":"createUserAccessToken","requestBody":{"$ref":"#/components/requestBodies/CreateUserAccessTokenRequest"},"responses":{"201":{"$ref":"#/components/responses/CreateUserAccessTokenResponse"},"400":{"$ref":"#/components/responses/GenericErrorResponse"}}}}}} ``` ## Delete a user access token > Delete a user access token by me (logged in user) ```json {"openapi":"3.0.3","info":{"title":"AppMaker API - OAS 3.0","version":"1.0.0"},"tags":[{"name":"me","description":"Endpoints for the authenticated user."},{"name":"user-access-token","description":"Manage user access tokens."}],"servers":[{"url":"https://abp-api.akinon.net/api/v1","description":"Production server"},{"url":"https://abptest-api.akinon.net/api/v1","description":"Test server"},{"url":"http://localhost:5001/api/v1","description":"Local server"}],"security":[{"bearerAuth":[]},{"accessToken":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"accessToken":{"type":"apiKey","in":"header","name":"x-access-token"}},"parameters":{"TokenIdPathParam":{"name":"tokenId","in":"path","required":true,"description":"Token ID","schema":{"$ref":"#/components/schemas/MongoId"}}},"schemas":{"MongoId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"Entity ID"},"BadRequestError":{"type":"object","properties":{"apiError":{"type":"array","items":{"type":"string"},"description":"Error message"}}},"UnauthorizedError":{"type":"object","properties":{"apiError":{"type":"array","items":{"type":"string"},"description":"Error message"}}},"ForbiddenError":{"type":"object","properties":{"apiError":{"type":"array","items":{"type":"string"},"description":"Error message"}}}},"responses":{"NoContentResponse":{"description":"No Content"},"BadRequestResponse":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"UnauthorizedErrorResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"ForbiddenErrorResponse":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}}}},"paths":{"/me/tokens/{tokenId}":{"delete":{"tags":["user-access-token","me"],"summary":"Delete a user access token","description":"Delete a user access token by me (logged in user)","operationId":"deleteUserAccessToken","parameters":[{"$ref":"#/components/parameters/TokenIdPathParam"}],"responses":{"204":{"$ref":"#/components/responses/NoContentResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://apidocs.akinon.com/app-maker-open-apis/profile/user-access-token.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.