Documentation/cmd-check-project-access.txt

= gerrit check-project-access

== NAME
gerrit check-project-access - Check project readability of all users in a
matching the given link:rest-api-accounts.html#account-id[account identifier]

== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit check-project-access_
  [--project <PROJECT> | -p <PROJECT>]
  [--user <USER> | -u <USER>]
--

== DESCRIPTION
Allow users to check if user has access to a project’s changes, comments, code
differences, and Git access over SSH or HTTP.

It returns all users in given input String, where it includes: username, email
address and full name.

== ACCESS
Users who have view access and administrate server capability.

== EXAMPLES
Check if users can read all references in the repository called "test_project",
in given input String TestUser.

Given that there are
a user with username "test_user1", email "one@email.com", and Full name as
TestUser,
a user with username "test_user2", email "two@email.com", and Full name as
TestUser,
a user with username "test_user3", email "TestUser@email.com", and Full name
as John Doe

----
$ ssh -p @SSH_PORT@ @SSH_HOST@ gerrit check-project-access
  -p test_project
  -u TestUser

Username: 'test_user1', Email: 'one@example.com',  Full Name: 'TestUser'
, Result: TRUE
Username: 'test_user3', Email: 'TestUser@example.com',  Full Name: 'John Doe'
, Result: FALSE
Username: 'test_user2', Email: 'two@example.com',  Full Name: 'TestUser'
, Result: FALSE
----

----
$ ssh -p @SSH_PORT@ @SSH_HOST@ gerrit check-project-access
  -p test_project_doesnt_exist
  -u TestUser

fatal: project 'test_project_doesnt_exist' is unavailable
----

----
$ ssh -p @SSH_PORT@ @SSH_HOST@ gerrit check-project-access
  -p test_project
  -u test_user_doesnt_exist

fatal: No accounts found for your query: "test_user_doesnt_exist"
Tip: Try double-escaping spaces, for example: "--user Last,\\ First"
----


GERRIT
------
Part of link:index.html[Gerrit Code Review]

SEARCHBOX
---------