API tokens

You can use an API token to authenticate a script or other process with an Atlassian cloud product. You generate the token from your Atlassian account, then copy and paste it to the script.

If you use two-step verification to authenticate, your script will need to use a REST API token to authenticate.

API tokens can be used with the Jira Cloud and Confluence Cloud REST APIs.

If you're using Bitbucket Cloud, see App passwords.

Create an API token

Create an API token from your Atlassian account:

  1. Log in to https://id.atlassian.com/manage/api-tokens.
  2. Click Create API token.
  3. From the dialog that appears, enter a memorable and concise Label for your token and click Create.
  4. Click Copy to clipboard, then paste the token to your script, or elsewhere to save:

Note:

  • For security reasons it isn't possible to view the token after closing the creation dialog; if necessary, create a new token.
  • You should store the token securely, just as for any password.


Use an API token

A primary use case for API tokens is to allow scripts to access REST APIs for Atlassian cloud products using HTTP basic authentication.

Depending on the details of the HTTP library you use, simply replace your password with the token. For example, when using curl, you could do something like this:

curl -v https://mysite.atlassian.net --user me@example.com:my-api-token

Note that me@example.com here is the email address for the Atlassian account you're using to create the token.



Tokens de API

Puedes utilizar un token de API para autenticar un script u otro proceso con un producto de Atlassian Cloud. Tan solo tienes que generar el token en tu cuenta de Atlassian, copiarlo y pegarlo en el script.

Si usas la verificación en dos pasos para la autenticación, el script deberá usar un token de API de REST.

Los tokens de API se pueden utilizar con las API de REST de Jira Cloud y Confluence Cloud.

Si usas Bitbucket Cloud, consulta App passwords (Contraseñas de la aplicación).

Creación de un token de API

Crea un token de API en tu cuenta de Atlassian:

  1. Inicia sesión en https://id.atlassian.com/manage/api-tokens.

  2. Haz clic en Crear token de API.

  3. En el cuadro de diálogo que aparezca, introduce una Etiqueta fácil de recordar y concisa para tu token y haz clic en Crear.

  4. Haz clic en Copiar al portapapeles y, a continuación, pega el token en tu script o en cualquier otro lugar para guardarlo:

Nota:

  • Por cuestiones de seguridad, no se puede ver el token después de cerrar el cuadro de diálogo de creación. Si es necesario, crea un nuevo token.

  • Debes guardar el token de forma segura, como cualquier otra contraseña.

Uso de un token de API

Uno de los principales casos en los que se utilizan los tokens de API es para permitir que los scripts accedan a las API de REST relativas a los productos de Atlassian Cloud con una autenticación HTTP básica.

En función de los detalles de la biblioteca HTTP que uses, basta con sustituir tu contraseña por el token. Por ejemplo, si empleas el comando curl, puedes hacer algo así:

curl -v https://mysite.atlassian.net --user me@example.com:my-api-token

Ten en cuenta que, aquí, me@example.com es la dirección de correo electrónico de la cuenta de Atlassian que estás utilizando para crear el token.

Jetons d'API

Vous pouvez utiliser un jeton d'API pour authentifier un script ou un autre processus auprès d'un produit Atlassian Cloud. Générez le jeton depuis votre compte Atlassian, puis copiez-le et collez-le dans le script.

Si vous utilisez la validation en deux étapes, votre script doit faire appel à un jeton d'API REST pour l'authentification.

Les jetons d'API peuvent être utilisés avec les API REST de Jira Cloud et Confluence Cloud.

Si vous utilisez Bitbucket Cloud, reportez-vous à App passwords (Mots de passe d'app).

Créer un jeton d'API

Pour créer un jeton d'API depuis votre compte Atlassian, procédez comme suit :

  1. Connectez-vous à l'adresse : https://id.atlassian.com/manage/api-tokens.

  2. Cliquez sur Créer un jeton d'API.

  3. Dans la boîte de dialogue qui s'affiche, saisissez une étiquette courte et facile à retenir pour votre jeton, puis cliquez sur Créer.

  4. Cliquez sur Copier dans le presse-papiers, puis collez le jeton dans votre script ou ailleurs pour l'enregistrer :

Remarque :

  • Pour des raisons de sécurité, il n'est pas possible de voir le jeton après avoir fermé la boîte de dialogue de création ; si nécessaire, créez de nouveau un jeton.

  • Vous devez stocker le jeton en toute sécurité, comme pour tout mot de passe.

Utiliser un jeton d'API

Un des principaux cas d'usage des jetons d'API consiste à permettre aux scripts d'accéder aux API REST pour les produits Atlassian Cloud en utilisant l'authentification de base HTTP.

En fonction des détails de la bibliothèque HTTP que vous utilisez, il suffit de remplacer votre mot de passe par le jeton. Par exemple, lorsque vous utilisez la commande curl, vous pouvez avoir :

curl -v https://mysite.atlassian.net --user me@example.com:my-api-token

Remarque : ici, me@example.com est l'adresse e-mail associée au compte Atlassian que vous utilisez pour créer le jeton.

Tokens de API

Você pode usar um token de API para autenticar um script ou outro processo com um produto Atlassian Cloud. Você gera o token a partir de sua conta da Atlassian e, em seguida, copia e cola no script.

Se você usar a verificação em duas etapas para autenticar, o script vai precisar usar um token de API REST para autenticar.

Tokens de API podem ser usados com as APIs REST do Jira Cloud e Confluence Cloud.

Se estiver usando o Bitbucket Cloud, consulte Senhas dos aplicativos.

Crie um token de API

Crie um token de API a partir de sua conta da Atlassian:

  1. Entre em https://id.atlassian.com/manage/api-tokens.

  2. Clique em Criar token de API.

  3. Na caixa de diálogo que aparece, digite uma Categoria curta e fácil de lembrar para o token e clique em Criar.

  4. Clique em Copiar para área de transferência e, em seguida, cole o token no script ou em qualquer outro lugar para salvar:

Observação:

  • Por motivos de segurança, não é possível visualizar o token após fechar a caixa de diálogo de criação: se for necessário, crie um novo token.

  • Você deve armazenar o token com segurança, como o faz com as senhas.

Use um token de API

Um caso de uso primário para tokens de API é permitir que scripts acessem APIs REST para produtos do Atlassian Cloud usando autenticação básica HTTP.

Dependendo dos dados da biblioteca de HTTP que você usa, substitua sua senha pelo token. Por exemplo, ao utilizar curl, você poderia fazer algo assim:

curl -v https://mysite.atlassian.net --user me@example.com:my-api-token

Observe que me@example.com aqui é o endereço de e-mail da conta da Atlassian que está sendo usada para criar o token.

API-Token

Mit einem API-Token können Sie ein Skript oder einen anderen Prozess bei einem Atlassian Cloud-Produkt authentifizieren. Dazu müssen Sie nur über Ihr Atlassian-Konto das Token erstellen, es kopieren und es im Skript einfügen.

Wenn Sie die Zwei-Faktor-Authentifizierung nutzen, ist bei Ihrem Skript ein REST-API-Token zur Authentifizierung erforderlich.

API-Token können für die REST-APIs von Jira Cloud und Confluence Cloud verwendet werden.

Wenn Sie mit Bitbucket Cloud arbeiten, finden Sie bei den Informationen zu App-Passwörtern weitere Hinweise.

Erstellen eines API-Tokens

So erstellen Sie ein API-Token über Ihr Atlassian-Konto:

  1. Loggen Sie sich unter https://id.atlassian.com/manage/api-tokens ein.

  2. Klicken Sie auf Create API token (API-Token erstellen).

  3. Geben Sie im daraufhin angezeigten Dialogfeld ein leicht zu merkendes, kurzes Label für Ihr Token ein, und klicken Sie dann auf Create (Erstellen).

  4. Klicken Sie auf Copy to clipboard (In die Zwischenablage kopieren), und fügen Sie das Token dann in Ihr Skript ein oder fügen Sie es an anderer Stelle ein, um es zu speichern:

Hinweis:

  • Aus Sicherheitsgründen kann das Token nach dem Schließen des Erstellungsdialogfelds nicht noch einmal angezeigt werden. Erstellen Sie bei Bedarf ein neues Token.

  • Bewahren Sie das Token ebenso wie alle anderen Passwörter sicher auf.

Verwenden eines API-Tokens

In erster Linie werden API-Token genutzt, um Skripts den Zugriff auf REST-APIs für Atlassian Cloud-Produkte unter Verwendung der grundlegenden HTTP-Authentifizierung zu gewähren.

Je nach den Details der von Ihnen genutzten HTTP-Bibliothek müssen Sie einfach nur Ihr Passwort durch das Token ersetzen. Bei curl könnte dies beispielsweise wie folgt aussehen:

curl -v https://mysite.atlassian.net --user me@example.com:my-api-token

Hinweis: me@example.com ist hier die E-Mail-Adresse des zum Erstellen des Tokens verwendeten Atlassian-Kontos.

Last modified on Dec 2, 2020

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.