Skip to content

feat: add usage instructions for organization parameter in SSO credential scripts #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshjohanning merged 1 commit into from
Jul 31, 2025
Merged

feat: add usage instructions for organization parameter in SSO credential scripts #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions gh-cli/get-sso-credential-authorizations.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
#!/bin/bash

if [ -z "$1" ]; then
echo "Usage: $0 <organization>"
echo "Example: ./get-sso-enabled-pats.sh my-org"
exit 1
fi

org="$1"

# more info:
# - https://github.blog/changelog/2019-04-09-credential-authorizations-api/
# - https://github.blog/changelog/2021-11-09-expiration-dates-of-saml-authorized-pats-available-via-api/
# - https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/orgs?apiVersion=2022-11-28#list-saml-sso-authorizations-for-an-organization

# gets all credential types ("personal access token", "SSH key", "OAuth app token", and "GitHub app token") and their expiration (if applicable)

gh api --paginate /orgs/githubcustomers/credential-authorizations
gh api --paginate /orgs/$org/credential-authorizations

# old - raw text output, 1 per line
# gh api --paginate /orgs/githubcustomers/credential-authorizations --jq='.[] | "login: \(.login) expiration: \(.authorized_credential_expires_at) ID: \(.credential_id) note: \(.authorized_credential_note) type: \(.credential_type)"'
# gh api --paginate /orgs/$org/credential-authorizations --jq='.[] | "login: \(.login) expiration: \(.authorized_credential_expires_at) ID: \(.credential_id) note: \(.authorized_credential_note) type: \(.credential_type)"'
14 changes: 11 additions & 3 deletions gh-cli/get-sso-enabled-pats.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
#!/bin/bash

if [ -z "$1" ]; then
echo "Usage: $0 <organization>"
echo "Example: ./get-sso-enabled-pats.sh my-org"
exit 1
fi

org="$1"

# more info:
# - https://github.blog/changelog/2019-04-09-credential-authorizations-api/
# - https://github.blog/changelog/2021-11-09-expiration-dates-of-saml-authorized-pats-available-via-api/
# - https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/orgs?apiVersion=2022-11-28#list-saml-sso-authorizations-for-an-organization

# credential_type: personal access token, SSH key, OAuth app token, GitHub app token
gh api --paginate /orgs/githubcustomers/credential-authorizations --jq='.[] | select(.credential_type == "personal access token" and .token_last_eight != null)' # the null check is b/c we only want to get active PATs
gh api --paginate /orgs/$org/credential-authorizations --jq='.[] | select(.credential_type == "personal access token" and .token_last_eight != null)' # the null check is b/c we only want to get active PATs

# old - raw text output, 1 per line
# gh api --paginate /orgs/githubcustomers/credential-authorizations --jq='.[] | select(.credential_type == "personal access token" and .token_last_eight != null) | "login: \(.login) expiration: \(.authorized_credential_expires_at) ID: \(.credential_id) note: \(.authorized_credential_note) type: \(.credential_type))"'
# gh api --paginate /orgs/$org/credential-authorizations --jq='.[] | select(.credential_type == "personal access token" and .token_last_eight != null) | "login: \(.login) expiration: \(.authorized_credential_expires_at) ID: \(.credential_id) note: \(.authorized_credential_note) type: \(.credential_type))"'

# old - raw text output, 1 per line, with scopes
# gh api --paginate /orgs/githubcustomers/credential-authorizations --jq='.[] | select(.credential_type == "personal access token" and .token_last_eight != null) | "login: \(.login) expiration: \(.authorized_credential_expires_at) ID: \(.credential_id) note: \(.authorized_credential_note) type: \(.credential_type) scopes: \((.scopes // ["None"]) | join(", "))"'
# gh api --paginate /orgs/$org/credential-authorizations --jq='.[] | select(.credential_type == "personal access token" and .token_last_eight != null) | "login: \(.login) expiration: \(.authorized_credential_expires_at) ID: \(.credential_id) note: \(.authorized_credential_note) type: \(.credential_type) scopes: \((.scopes // ["None"]) | join(", "))"'
12 changes: 10 additions & 2 deletions gh-cli/get-sso-enabled-ssh-keys.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
#!/bin/bash

if [ -z "$1" ]; then
echo "Usage: $0 <organization>"
echo "Example: ./get-sso-enabled-pats.sh my-org"
exit 1
fi

org="$1"

# more info:
# - https://github.blog/changelog/2019-04-09-credential-authorizations-api/
# - https://github.blog/changelog/2021-11-09-expiration-dates-of-saml-authorized-pats-available-via-api/
# - https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/orgs?apiVersion=2022-11-28#list-saml-sso-authorizations-for-an-organization

# credential_type: personal access token, SSH key, OAuth app token, GitHub app token
gh api --paginate /orgs/githubcustomers/credential-authorizations --jq='.[] | select(.credential_type == "SSH key")'
gh api --paginate /orgs/$org/credential-authorizations --jq='.[] | select(.credential_type == "SSH key")'

# old - raw text output, 1 per line
# gh api --paginate /orgs/githubcustomers/credential-authorizations --jq='.[] | select(.credential_type == "SSH key") | "login: \(.login) ID: \(.credential_id) title: \(.authorized_credential_title) type: \(.credential_type)"'
# gh api --paginate /orgs/$org/credential-authorizations --jq='.[] | select(.credential_type == "SSH key") | "login: \(.login) ID: \(.credential_id) title: \(.authorized_credential_title) type: \(.credential_type)"'