'Every error in the book from google-api-ruby-client but no data

I have been attempting to work on a request from my boss this week that requires using the google admin directory api.

At this point I am questioning if what I am trying to do is even possible.

  • Can I retrieve data from the scope "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly" with a service account? Is it even possible?

The errors I have seen in the past hour are below... Many of them sound the same and I have no idea what is going on or why this is such a difficult journey for such basic information.

  1. PERMISSION_DENIED: Request had insufficient authentication scopes. (Google::Apis::ClientError)

  2. `check_status': Unauthorized (Google::Apis::AuthorizationError)

  3. Authorization failed. Server message: (Signet::AuthorizationError) { "error": "unauthorized_client", "error_description": "Client is unauthorized to retrieve access tokens using this method, or client not authorized for any of the scopes requested." }

  4. `check_status': permission_denied: request had insufficient authentication scopes

  5. `check_status': badRequest: Bad Request

My current test script is below...

require "google/apis/admin_directory_v1"
require "googleauth"
require "googleauth/stores/file_token_store"
require "fileutils"

APPLICATION_NAME = "Directory API Ruby Quickstart".freeze
CREDENTIALS_PATH = "credentials.json".freeze
CUSTOMER_ID = "thasgunnabeanopefrommedawg".freeze

SCOPE = ["https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"].freeze

authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
  json_key_io: 
File.open('credentials.json'),
  scope: SCOPE)
authorizer.update!(sub: "[email protected]")
authorizer.fetch_access_token!

# puts authorize

# Initialize the API
service = Google::Apis::AdminDirectoryV1::DirectoryService.new
service.client_options.application_name = APPLICATION_NAME
service.authorization = Google::Auth.get_application_default(SCOPE)

response = service.list_mobile_devices(customer_id: CUSTOMER_ID)
puts response.to_json

EDITS BELOW *** [27th, MAY, 2022]

I have been trying with ruby, python, and postman for two weeks at this point :/

Last night I took the ruby snippet that was posted by user:Daimto below.

I was able to return a token with the following modified version of the ruby snippet provided in the answer below.

require 'googleauth'
require 'google/apis/admin_directory_v1'

creds = {
  "type": "service_account",
  "project_id": "MYPROJECTNAME",
  "private_key_id": "MYPRIVATEKEYID",
  "private_key": "-----BEGIN PRIVATE KEY-----\n-MY PRIVATE KEY 
WILL BE HERE BUT REMOVED FOR SECURITY-----END PRIVATE KEY-----\n",
"client_email": "[email protected]",
  "client_id": "MYCLIENTIDISACTUALLYHERE",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/compute%40developer.gserviceaccount.com"
}

creds_json = creds.to_json
creds_json_io = StringIO.new(creds_json)
auth = Google::Auth::ServiceAccountCredentials.make_creds(
  json_key_io: creds_json_io, 
scope["https://www.googleapis.com/auth/admin.directory.device.mobile.readonly","https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly","https://www.googleapis.com/auth/admin.directory.device.mobile"]
)
    auth.sub = "emailfrommyserviceaccount- 
   [email protected]" 

puts auth.fetch_access_token

Please excuse the formatting.

I took the service account out of the env variable for now to make sure I can get it to work without adding extra layers of abstraction at this time.

When trying to add the additional code from the Directory Api Quickstart to the above snip I STILL RETURN THE ERROR

/var/lib/gems/2.7.0/gems/google-apis-core-0.5.0/lib/google/apis/core/http_command.rb:224:in `check_status': Unauthorized (Google::Apis::AuthorizationError)

The additional code added is below... The last line of the previous snip gets changed to the first line of the snip that comes after this. This is to properly pass the token to the example after modifying user:Daimto's response.

authorize = auth.fetch_access_token

# Initialize the API
service = Google::Apis::AdminDirectoryV1::DirectoryService.new
service.client_options.application_name = "my-application-name"
service.authorization = authorize
# List the first 10 users in the domain
response = service.list_users(customer:    "my_customer",
                              max_results: 10,
                              order_by:    "email")
puts "Users:"
puts "No users found" if response.users.empty?
response.users.each { |user| puts "- #{user.primary_email} (#{user.name.full_name})" }


Solution 1:[1]

The method Method: mobiledevices.list requires one of the following scopes.

enter image description here

So to answer your first question yes you can use the https://www.googleapis.com/auth/admin.directory.device.mobile.readonly scope.

Error number 1

PERMISSION_DENIED: Request had insufficient authentication scopes.

You were probably getting this error when you had supplied a different scope.

Error 3;

 Client is unauthorized to retrieve access tokens using this method, or client not authorized for any of the scopes requested.

There are three types of clients you can create on google cloud console.

  • web client
  • native client
  • service account

The json file you get from creating these clients is all different. The code that uses them is also different. The error is telling you that you have a client.json file that you are using which does not match the type of code you are using.

How to create service account credetinals

The code for a service account would be like this Not tested you may need to fix the scope. Remember that the service account needs to be configured properly on your workspace domain for the sub to work.

require 'googleauth'
require 'google/apis/admin_v1'

creds = ENV['GOOGLE_SERVICE_ACCOUNT'] # JSON downloaded from cloud console
                                      # is saved in this ENV variable
creds_json = JSON.parse(creds)
creds_json_io = StringIO.new(creds_json.to_json)
auth = Google::Auth::ServiceAccountCredentials.make_creds(
  json_key_io: creds_json_io,
  scope: [Google::Apis::ADMINV1::ADMIN_DIRECTORY_MOBILE_READONLY]
)
auth.sub = '[email protected]' 
auth.fetch_access_token

Tip: You have a lot of errors there, I feel that you have been struggling with this for a while. Advice step back, have a look at the sample on the readme for the Google-api-ruby-client. Start over. Just get your auth to work. Once you get the code right and the client right all the pieces will fit into place.

Sources

This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.

Source: Stack Overflow

Solution Source
Solution 1