Travis CI API Docs

User

An individual user.

Attributes

Minimal Representation

Included when the resource is returned as part of another resource.

NameTypeDescription
idIntegerValue uniquely identifying the user.
loginStringLogin set on Github.
nameStringName set on GitHub.
vcs_typeUnknownThe user's vcs_type.
ro_modeUnknownThe user's ro_mode.

Standard Representation

Included when the resource is the main response of a request, or is eager loaded.

NameTypeDescription
idIntegerValue uniquely identifying the user.
loginStringLogin set on Github.
nameStringName set on GitHub.
github_idIntegerId set on GitHub.
vcs_idUnknownThe user's vcs_id.
vcs_typeUnknownThe user's vcs_type.
avatar_urlStringAvatar URL set on GitHub.
educationBooleanWhether or not the user has an education account.
allow_migrationUnknownThe user's allow_migration.
allowanceUnknownThe user's allowance.
ro_modeUnknownThe user's ro_mode.
custom_keysUnknownThe user's custom_keys.
emailUnknownThe user's email.
is_syncingBooleanWhether or not the user is currently being synced with Github.
synced_atStringThe last time the user was synced with GitHub.
recently_signed_upUnknownThe user's recently_signed_up.
secure_user_hashUnknownThe user's secure_user_hash.
ro_modeUnknownThe user's ro_mode.
confirmed_atUnknownThe user's confirmed_at.
custom_keysUnknownThe user's custom_keys.

Additional Attributes

NameTypeDescription
repositories[Repository]Repositories belonging to this user.
installationInstallationInstallation belonging to the user.
emailsUnknownThe user's emails.
collaboratorUnknownThe user's collaborator.

Actions

Find

This will return information about an individual user.

GET
/user/{user.id}
Template VariableTypeDescription
user.idIntegerValue uniquely identifying the user.
Query ParameterTypeDescription
include[String]List of attributes to eager load.

Example:GET /user/invalid

Sync

This triggers a sync on a user's account with their GitHub account.

POST
/user/{user.id}/sync
Template VariableTypeDescription
user.idIntegerValue uniquely identifying the user.

Example:POST /user/invalid/sync

Current

This will return information about the current user.

GET
/user
Query ParameterTypeDescription
include[String]List of attributes to eager load.

Example:GET /user

Update

Document resources/user/actions/update not found.

PATCH
/user
Accepted ParameterTypeDescription
user.utm_paramsUnknownDocumentation missing.

Example:PATCH /user

Logout

Document resources/user/actions/logout not found.

GET
/logout
Query ParameterTypeDescription
include[String]List of attributes to eager load.

Example:GET /logout