Some organizations host their own packages on private package registries that require authentication to access. If you are an employee or customer of one of those organizations, you must configure a scoped registry with npm authentication. To set this up, get an npm authentication token and then add that token to your user configuration file.
The process of creating and accessing an npm authentication token is different for each registry provider. For example, JFrog’s Artifactory repository manager uses a different procedure to generate the authentication token from npm. This is an example of a typical procedure, but you need to follow the process recommended by the specific package registry provider for your scoped registry.
To fetch an authentication token from npm:
Install npm locally on your computer.
From a terminal, enter the following command to log in to the registry:
$ npm login --registry <registry url>
Locate and open the generated .npmrc file.
Locate either the _authToken
or the _auth
entry and copy its value (refer to the example below).
Depending on the registry, the token string can be either a globally unique identifier (GUID), a token, or a proprietary-formatted string.
This is an example of an .npmrc
file containing an _authToken
attribute:
registry=https://example.com:1234/mylocation/ //example.com:1234/mylocation/:_authToken=<AUTH TOKEN>
This is an example of an .npmrc
file containing an_auth
attribute:
registry=https://example.com:1234/mylocation _auth=<AUTH TOKEN> email=<EMAIL> always-auth=true
Store your token information for each scoped registry that requires authentication in the .upmconfig.toml
user configuration file using the npmAuth
configuration schema.
After you save this information to the configuration file, Package Manager will provide your authentication information on every request made to each registry in the file.
Follow these instructions to add your authentication information to the user configuration file:
Locate the .upmconfig.toml
user configuration file. If the file doesn’t exist, create an empty text file.
Format your authentication information using a schema, depending on whether you are using a Bearer (token-based) or Basic (Base64-encrypted) authentication mechanism.
[npmAuth."<REGISTRY URL>"] <TOKEN-PROPERTY> = "<TOKEN-VALUE>" email = "<EMAIL>" alwaysAuth = <BOOLEAN>
The information in the following table explains how to specify the configuration file values:
Entry | Description |
---|---|
[npmAuth."<REGISTRY-URL>"] |
Required. URL for the registry. For example, [npmAuth."https://example.com:8081/mylocation"] . |
<TOKEN-PROPERTY> = "<TOKEN-VALUE>" |
Required. The authentication token generated from the npm registry. This can be a GUID, a token, or a proprietary-formatted string. For example, this can be either token = "<AUTH TOKEN>" (Bearer) or _auth = "<BASE64 TOKEN>" (Basic). |
Optional. Email address for the user matching the user’s email on the registry. | |
alwaysAuth | Optional. Set to true if the package metadata and tarballs aren’t located on the same server. Typically, you can copy the value from the .npmrc file you generated. |
[npmAuth."http://localhost:8081/myrepository/mylocation"] token = "NpmToken.2348c7ea-6f86-3dbe-86b6-f257e86569a8" alwaysAuth = true [npmAuth."http://localhost:4873"] token = "eaJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWFsX2dyb3VwcyI6WyJwYXNjYWxsIl0sIm5hbWUiOiJwYXNjYWxsIiwiZ3JvdXBzIjpbIn" [npmAuth."https://api.bintray.example/npm/mycompany/myregistry"] token = "aGFzY2FsbDo4ZWIwNTM5NzBjNTI3OTIwYjQ4MDVkYzY2YWEzNmQxOTkyNDYzZjky" email = "username@example.com" alwaysAuth = true
These steps use Azure DevOps as an example, but the process is similar for any platform that uses a personal access token (PAT).
Before you begin, install Node.js if it’s not already installed.
Get your Azure DevOps personal access token (PAT), and have it ready for a later step. If you need to regenerate your PAT, log in to Azure DevOps (https://dev.azure.com) and go to User settings > Personal access tokens. For information about using PATs, refer to the Microsoft article, Use personal access tokens.
From a command line, run the following command:
node -e "require('readline').createInterface({input:process.stdin,output:process.stdout,historySize:0}).question('Enter PAT> ',p => {b64=Buffer.from(p.trim()).toString('base64');console.log(b64);process.exit();})"
At the Enter PAT
prompt, type email:PAT
, replacing:
email
with the email associated with your Azure DevOps account and the email specified in the .upmconfig.toml
filePAT
with your PAT from the earlier stepThe command returns a Base64-encrypted string. Copy that string and assign it as the value for the _auth
key in the .upmconfig.toml
file.
[npmAuth."http://localhost:8081/myrepository/mylocation"] _auth = "c19kaW5pcm9AaG90bWFpbC4jb206d3FzdzVhemU9Q==" email = "username@example.com" alwaysAuth = true
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.