MicrosoftDocs / vsts-rest-api-specs

MIT License
167 stars 115 forks source link

Instruction on Postman and its authentication #369

Open hwpvanholsteijn opened 4 years ago

hwpvanholsteijn commented 4 years ago

Instructions on API testing application Postman and its authentication would be great. Because, I have been looking for multiple hours which authentication-type was correct for my Postman applying to my business. An example of the Postman documentation could be:

Postman

In the case of Postman it important to notice that the authentication type will need to be Basic Auth with the Microsoft Azure DevOps username and the Personal Access Token (PAT) as password, Also the PAT can be found at https://dev.azure.com/{organisation-name}/_usersSettings/tokens

The change is applied for: https://docs.microsoft.com/en-us/rest/api/azure/devops/?view=azure-devops-rest-5.1

Please take this change in consideration.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

AlanMcBee commented 4 years ago

@hwpvanholsteijn Have you seen https://github.com/hkamel/azuredevops-postman-collections ? Also https://dev.to/omiossec/getting-started-with-azure-devops-api-with-powershell-59nn

hwpvanholsteijn commented 4 years ago

During that time I have to say no, because search results differ per county or region according to Google or Bing. In general, self explaining manuals are preferred. Therefore I would suggest to point the URL's to the additional documentation (for lower maintenance) or either write a small one paragraph manual. (In the case of a higher find-ability) Because, than then the chances of getting lost online search are decreased.