Search

type: "io.kestra.plugin.github.users.Search"

Search for GitHub users

If no authentication is provided, anonymous authentication will be used. Anonymous authentication can't retrieve full information

Examples

id: "search"
type: "io.kestra.plugin.github.users.Search"
id: users
type: io.kestra.plugin.github.users.Search
oauthToken: your_github_token
query: "kestra-io in:login language:java"

id: "search"
type: "io.kestra.plugin.github.users.Search"
id: users
type: io.kestra.plugin.github.users.Search
oauthToken: your_github_token
query: kestra-io
in: login
language: java

Properties

accountType

• Type: string
• Dynamic: ✔️
• Required: ❌
• Possible Values:
  • USER
  • ORGANIZATION

Restrict search results to personal accounts or organizations only

USER - the results will include only user accounts ORGANIZATION - the results will include only organization accounts

created

• Type: string
• Dynamic: ✔️
• Required: ❌

Filter users based on when they joined GitHub

Available formats:

• '<=YYYY-MM-DD' - joined at or before
• '>=YYYY-MM-DD' - joined at or after
• Similar cases for above two with ">", "<"
• 'YYYY-MM-DD..YYYY-MM-DD' - joined in period between

followers

• Type: string
• Dynamic: ✔️
• Required: ❌

Filter users based on the number of followers that they have

in

• Type: string
• Dynamic: ✔️
• Required: ❌

With the 'in' qualifier you can restrict your search to the username/login, full name, public email

Example kenya in:login matches users with the word "kenya" in their username. One more case of use to search users that have sponsor profile, equivalent to query: is:sponsorable

jwtToken

• Type: string
• Dynamic: ✔️
• Required: ❌

GitHub JWT token

Does not requires additional fields to log-in

language

• Type: string
• Dynamic: ✔️
• Required: ❌

Search for users based on the languages of repositories they own

Can be the language name or alias

location

• Type: string
• Dynamic: ✔️
• Required: ❌

Search for users by the location indicated in their profile

login

• Type: string
• Dynamic: ✔️
• Required: ❌

GitHub login

Requires additional field: oauthToken, to log-in

oauthToken

• Type: string
• Dynamic: ✔️
• Required: ❌

GitHub oauthToken

GitHub Personal Access Token. In addition, can be used with login or by its own

order

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: ASC
• Possible Values:
  • ASC
  • DESC

Order output

ASC - the results will be in ascending order (DEFAULT) DESC - the results will be in descending order

query

• Type: string
• Dynamic: ✔️
• Required: ❌

The query contains one or more search keywords and qualifiers

Qualifiers allow you to limit your search to specific areas of GitHub

repositories

• Type: integer
• Dynamic: ✔️
• Required: ❌

You can filter users based on the number of repositories they own

sort

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: JOINED
• Possible Values:
  • JOINED
  • REPOSITORIES
  • FOLLOWERS

Sort output

JOINED - the results will be sorted by when user joined to Github (DEFAULT) REPOSITORIES - the results will be sorted by the number of repositories owned by user FOLLOWERS - the results will be sorted by the number of followers that user has

Outputs

uri

• Type: string
• Dynamic: ❓
• Required: ❌
• Format: uri

Definitions