oauth2

OAuth2 Examples

This repository contains a collection of examples demonstrating the use of the OAuth2 API on the CrowdStrike Falcon platform. The examples are written in Ruby and use the Crimson Falcon Ruby SDK.

The current examples include:

• Get Access Token

Get Access Token

Returns a generated OAuth2 access token for your API credentials.

Execution Syntax

These samples leverage simple command-line arguments to implement functionality.

Execute the example:

ruby get_access_token.rb -k $FALCON_CLIENT_ID -s $FALCON_CLIENT_SECRET

Execute the example, specifying a cloud region:

ruby get_access_token.rb -k $FALCON_CLIENT_ID -s $FALCON_CLIENT_SECRET -c us-2

Execute the example, specifying a member CID:

ruby get_access_token.rb -k $FALCON_CLIENT_ID -s $FALCON_CLIENT_SECRET -m MEMBER_CID

Command-line help

Command-line help is available via the -h or --help flags.

ruby get_access_token.rb -h
Usage: get_access_token.rb -k FALCON_CLIENT_ID -s FALCON_CLIENT_SECRET [options]

    -k, --client-id FALCON_CLIENT_ID         OAuth2 API Client ID.
    -s, --client-secret FALCON_CLIENT_SECRET OAuth2 API Client Secret.
    -c, --cloud FALCON_CLOUD                 Falcon cloud region (default: us-1) | valid: us-1, us-2, eu-1, us-gov-1.
    -m, --member-cid MEMBER_CID              Member CID for MSSP
    -h, --help                               Show this message

Coming Soon

Stay tuned for more examples showcasing different functionalities of the OAuth2 API.