Skip to content

README.md

Latest commit

 

History

History
110 lines (83 loc) · 3.38 KB

README.md

File metadata and controls

110 lines (83 loc) · 3.38 KB

msauthify

License: MIT Release

  1. 📔 Description
  2. ⚠️ Before running
  3. 🔨 Installation
  4. ✍️ Usage
  5. 📑 Options
  6. 🧐 Examples
  7. 📃 License
  8. ❤️ Contribution

# Description

msauthify is a Node.js application for automating OAuth2 authentication with Microsoft services. It retrieves access tokens by leveraging the resource owner password credentials grant flow. This tool simplifies authentication for developers working with Microsoft APIs. Supports multiple applications.

# Before Running

Ensure that your AWS SSO profiles are configured using aws sso configure and your profiles are configured in a JSON file named msauthify.config. The format of the configuration file should include the following details:

  • custom_application_name: Custom application name.
    • tenantId: The Microsoft Azure tenant ID.
    • clientId: The application (client) ID from Azure.
    • clientSecret: The client secret for the application.
    • scope: The API scopes requested.
    • username: The username of the account for authentication.
    • password: The password of the account for authentication.

The msauthify.config file should be placed as follows:

  • Linux/macOS: ~/msauthify.config
  • Windows: %userprofile%\msauthify.config

# Installation

npm i -g msauthify

# Usage

Basic usage example:

msauthify [profiles]

The application will authenticate using the credentials provided in msauthify.config and output the access token.

# Options

N/A

# Examples

Linux: ~/msauthify.config
Windows: %userprofile%/msauthify.config

{
    "custom_application_name_1": {    
        "tenantId": "app1_tenantId",
        "clientId": "app1_clientId",
        "clientSecret": "app1_clientSecret",
        "scope": "app1_scope",
        "username": "app1_user@example.com",
        "password": "app1_password"
    },
    "custom_application_name_2": {    
        "tenantId": "app2_tenantId",
        "clientId": "app2_clientId",
        "clientSecret": "app2_clientSecret",
        "scope": "app2_scope",
        "username": "app2_user@example.com",
        "password": "app2_password"
    },
    ...
}

Single Application Output:

eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Inp...

Multiple Application Output:

----------
Token app1
----------
eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Inp...
----------
Token app2
----------
ZWcyV09OcFRr5Wk94Zz09IiwiYXbiI6InVzZXJfY22NhY2N...

# License

Distributed under the MIT License. See LICENSE for more information.

# Contributing

We welcome contributions to improve the functionality of msauthify! Here's how you can contribute:

  1. Fork the project
  2. Create a new feature branch (git checkout -b feature/YourFeature)
  3. Make your changes and commit (git commit -m 'Add feature')
  4. Push to your branch (git push origin feature/YourFeature)
  5. Open a pull request

Your contributions will be greatly appreciated!

⭐ Feel free to contribute ⭐