Search
Search for GitHub users.
If no authentication is provided, anonymous authentication will be used. Anonymous authentication can't retrieve full information.
type: "io.kestra.plugin.github.users.Search"
Examples
Search for users.
id: github_user_search_flow
namespace: company.team
tasks:
- id: search_users
type: io.kestra.plugin.github.users.Search
oauthToken: your_github_token
query: "kestra-io in:login language:java"
Search for users with conditions.
id: github_user_search_flow
namespace: company.team
tasks:
- id: search_users
type: io.kestra.plugin.github.users.Search
oauthToken: your_github_token
query: kestra-io
in: login
language: java
Properties
accountType string
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 string
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 string
Filter users based on the number of followers that they have.
in string
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 string
GitHub JWT token
Does not requires additional fields to log-in
language string
Search for users based on the languages of repositories they own.
Can be the language name or alias.
location string
Search for users by the location indicated in their profile.
login string
GitHub login
Requires additional field: oauthToken, to log-in
oauthToken string
GitHub oauthToken
GitHub Personal Access Token. In addition, can be used with login or by its own
order string
ASC
ASC
DESC
Order of the output.
ASC - the results will be in ascending order (DEFAULT)
DESC - the results will be in descending order
query string
The query contains one or more search keywords and qualifiers.
Qualifiers allow you to limit your search to specific areas of GitHub.
repositories integerstring
You can filter users based on the number of repositories they own.
sort string
JOINED
JOINED
REPOSITORIES
FOLLOWERS
Sort condition of the 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 string
uri