generatepersonalaccesstoken.md

Generate Personal Access Token

HTTP Method	URL	Requires Auth
POST	/api/v1/users.generatePersonalAccessToken	yes

{% hint style="info" %}

• Permission required: create-personal-access-tokens
• This endpoint required 2FA. Refer to #call-an-endpoint-with-2fa {% endhint %}

Body Parameters

Key	Example Value	Description
tokenName*	mypersonaltoken	The name of the token.
bypassTwoFactor	true or false	If 2FA requirement should be ignored when using this token. By default, the value is false.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/users.generatePersonalAccessToken \
     -d '{ 
          "tokenName": "mypersonaltoken", 
          "bypassTwoFactor": true }'

Example Response

{
  "token": "2jdk99wuSjXPO201XlAks9sjDjAhSJmskAKW301mSuj9Sk"
  "success": true
}

Change Log

Version	Description
3.1.0	Added bypassTwoFactor param
0.69.0	Added