API v1

This API is mounted on the /v1/ URL prefix.

POST /certs/

Send a CSR and get a signed certificate in return

Query Parameters:

• user (string) – User name.

• csr (string) – Certificate Signing Request.

• profile (string) – Certificate Profile.

Status Codes:

• 200 OK – Success

• 400 Bad Request – The CSR could not be signed

• 401 Unauthorized – Unauthorized. You need to be logged in.

Request Headers:

• X-Fields – An optional fields mask

GET /certs/{serial_number}/

Fetch a certificate given its serial number

Certificates are also present on users’ results, but this method gives more details.

Parameters:

• serial_number (integer) – The certificate’s serial number

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

• 404 Not Found – Certificate not found

Request Headers:

• X-Fields – An optional fields mask

GET /groups/

List all groups

Query Parameters:

• page_size (integer) – Page size.

• page_number (integer) – Page number.

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

Request Headers:

• X-Fields – An optional fields mask

GET /groups/{groupname}/

Fetch a group given their name

Parameters:

• groupname (string) – The group name

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

• 404 Not Found – Group not found

Request Headers:

• X-Fields – An optional fields mask

GET /groups/{groupname}/is-member/{username}

Check whether a user is a member of the group

Parameters:

• username (string) – The user name

• groupname (string) – The group name

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

• 404 Not Found – Group not found

GET /groups/{groupname}/members/

Fetch group members given the group name

Parameters:

• groupname (string) – The group name

Query Parameters:

• page_size (integer) – Page size.

• page_number (integer) – Page number.

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

• 404 Not Found – Group not found

Request Headers:

• X-Fields – An optional fields mask

GET /groups/{groupname}/sponsors/

Fetch group sponsors given the group name

Parameters:

• groupname (string) – The group name

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

• 404 Not Found – Group not found

Request Headers:

• X-Fields – An optional fields mask

GET /me/

Fetch the connected user

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

Request Headers:

• X-Fields – An optional fields mask

GET /search/users/

Fetch users given a search term

Query Parameters:

• page_size (integer) – Page size.

• page_number (integer) – Page number.

• email (string) – The email to search for (exact match)

• email__exact (string) – DEPRECATED: use email

• username (string) – The username to search for

• ircnick (string) – The ircnick to search for

• givenname (string) – The first name to search for

• surname (string) – The surname to search for

• human_name (string) – The full human name to search for

• github_username (string) – The username in GitHub.com

• gitlab_username (string) – The username in GitLab.com

• creation__before (string) – Search for users created before this date

• rhbzemail (string) – The bugzilla email to search for

• group (array) – Users must be a member of this group (exact match)

• username__exact (string) – The username to search for (exact match)

• ircnick__exact (string) – The ircnick to search for (exact match)

• givenname__exact (string) – The first name to search for (exact match)

• surname__exact (string) – The surname to search for (exact match)

• human_name__exact (string) – The full human name to search for (exact match)

• github_username__exact (string) – The username in GitHub.com (exact match)

• gitlab_username__exact (string) – The username in GitLab.com (exact match)

• rhbzemail__exact (string) – The bugzilla email to search for (exact match)

Status Codes:

• 200 OK – Success

• 400 Bad Request – Validation Error

• 401 Unauthorized – Unauthorized. You need to be logged in.

Request Headers:

• X-Fields – An optional fields mask

GET /users/

List all users

Query Parameters:

• page_size (integer) – Page size.

• page_number (integer) – Page number.

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

Request Headers:

• X-Fields – An optional fields mask

GET /users/{username}/

Fetch a user given their name

Parameters:

• username (string) – The user name

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

• 404 Not Found – User not found

Request Headers:

• X-Fields – An optional fields mask

GET /users/{username}/agreements/

Fetch a user’s agreements given their username

Parameters:

• username (string) – The user name

Query Parameters:

• page_size (integer) – Page size.

• page_number (integer) – Page number.

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

• 404 Not Found – User not found

Request Headers:

• X-Fields – An optional fields mask

GET /users/{username}/groups/

Fetch a user’s groups given their username

Parameters:

• username (string) – The user name

Query Parameters:

• page_size (integer) – Page size.

• page_number (integer) – Page number.

Status Codes:

• 200 OK – Success

• 401 Unauthorized – Unauthorized. You need to be logged in.

• 404 Not Found – User not found

Request Headers:

• X-Fields – An optional fields mask