brands

Creates, updates, deletes, gets or lists a brands resource.

Overview

Name	brands
Type	Resource
Id	google.iap.brands

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier of the brand. NOTE: GCP project number achieves the same brand identification purpose as only one brand per project can be created.
applicationTitle	string	Application name displayed on OAuth consent screen.
orgInternalOnly	boolean	Output only. Whether the brand is only intended for usage inside the G Suite organization only.
supportEmail	string	Support email displayed on the OAuth consent screen.

list

Successful response

Name	Datatype	Description
brands	array	Brands existing in the project.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, brandsId		Retrieves the OAuth brand of the project.
list	select	projectsId		Lists the existing brands for the project.
create	insert	projectsId		Constructs a new OAuth brand for the project if one does not exist. The created brand is "internal only", meaning that OAuth clients created under it only accept requests from users who belong to the same Google Workspace organization as the project. The brand is created in an un-reviewed status. NOTE: The "internal only" status can be manually changed in the Google Cloud Console. Requires that a brand does not already exist for the project, and that the specified support email is owned by the caller.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
brandsId	string
projectsId	string

SELECT examples

get

Retrieves the OAuth brand of the project.

SELECT
name,
applicationTitle,
orgInternalOnly,
supportEmail
FROM google.iap.brands
WHERE projectsId = '{{ projectsId }}' -- required
AND brandsId = '{{ brandsId }}' -- required;

list

Lists the existing brands for the project.

SELECT
brands
FROM google.iap.brands
WHERE projectsId = '{{ projectsId }}' -- required;

INSERT examples

create

Constructs a new OAuth brand for the project if one does not exist. The created brand is "internal only", meaning that OAuth clients created under it only accept requests from users who belong to the same Google Workspace organization as the project. The brand is created in an un-reviewed status. NOTE: The "internal only" status can be manually changed in the Google Cloud Console. Requires that a brand does not already exist for the project, and that the specified support email is owned by the caller.

INSERT INTO google.iap.brands (
data__supportEmail,
data__applicationTitle,
projectsId
)
SELECT 
'{{ supportEmail }}',
'{{ applicationTitle }}',
'{{ projectsId }}'
RETURNING
name,
applicationTitle,
orgInternalOnly,
supportEmail
;

Manifest

# Description fields are for documentation purposes
- name: brands
  props:
    - name: projectsId
      value: string
      description: Required parameter for the brands resource.
    - name: supportEmail
      value: string
      description: >
        Support email displayed on the OAuth consent screen.
        
    - name: applicationTitle
      value: string
      description: >
        Application name displayed on OAuth consent screen.