# External User ID

### Introduction

An external user is your way to set a custom username in Keyless, allowing you to represent Keyless users with an identifier that is more familiar to your business such as a Unique identifier, GUID or UUID. Customers are explicitly advised not to input pii in this field (i.e. custom usernames, names or email addresses).

{% hint style="success" %}
For customers using the Authentication Service (which supports IDV Bridge SaaS and WebSDK), the External User ID documented on this page is mapped automatically to the Username in that service and vice-versa for ease of use.
{% endhint %}

{% openapi src="/files/wUAxLtBzLNEmWL9B3QOS" path="/users/{userId}/external-user" method="post" %}
[swagger-operations-service.yaml](https://424053338-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MCDr5oxGulTybKzhddo%2Fuploads%2Fgit-blob-80f0c096b523cb6a0d6ab1982fa047b165259269%2Fswagger-operations-service.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/wUAxLtBzLNEmWL9B3QOS" path="/users/{userId}/external-user" method="patch" %}
[swagger-operations-service.yaml](https://424053338-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MCDr5oxGulTybKzhddo%2Fuploads%2Fgit-blob-80f0c096b523cb6a0d6ab1982fa047b165259269%2Fswagger-operations-service.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/wUAxLtBzLNEmWL9B3QOS" path="/external-users/{externalUserId}" method="delete" %}
[swagger-operations-service.yaml](https://424053338-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MCDr5oxGulTybKzhddo%2Fuploads%2Fgit-blob-80f0c096b523cb6a0d6ab1982fa047b165259269%2Fswagger-operations-service.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/wUAxLtBzLNEmWL9B3QOS" path="/external-users/{externalUserId}/users" method="get" %}
[swagger-operations-service.yaml](https://424053338-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MCDr5oxGulTybKzhddo%2Fuploads%2Fgit-blob-80f0c096b523cb6a0d6ab1982fa047b165259269%2Fswagger-operations-service.yaml?alt=media)
{% endopenapi %}


---

# Agent Instructions: 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:

```
GET https://docs.keyless.io/consumer/server-api/external-users.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.