Version 4.0.24.8 (latest)
Register an OAuth2 Client App
Registers details identifying an external web app or native app as an OAuth2 login client of the Looker instance. The app registration must provide a unique client_guid and redirect_uri that the app will present in OAuth login requests. If the client_guid and redirect_uri parameters in the login request do not match the app details registered with the Looker instance, the request is assumed to be a forgery and is rejected.
Request
POST
/oauth_client_apps/{client_guid}
Datatype
Description
Request
path
Expand HTTP Path definition...
client_guid
The unique id of this application
body
Expand HTTP Body definition...
body
OAuth Client App
Expand OauthClientApp definition...
can
lock
Operations the current user is able to perform on this object
client_guid
lock
The globally unique id of this application
redirect_uri
The uri with which this application will receive an auth code by browser redirect.
display_name
The application's display name
description
A description of the application that will be displayed to users
enabled
When enabled is true, OAuth2 and API requests will be accepted from this app. When false, all requests from this app will be refused. Setting disabled invalidates existing tokens.
group_id
If set, only Looker users who are members of this group can use this web app with Looker. If group_id is not set, any Looker user may use this app to access this Looker instance
tokens_invalid_before
lock
All auth codes, access tokens, and refresh tokens issued for this application prior to this date-time for ALL USERS will be invalid.
activated_users
query
Expand HTTP Query definition...
fields
Requested fields.
Response
200: OAuth Client App
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
client_guid
lock
The globally unique id of this application
redirect_uri
The uri with which this application will receive an auth code by browser redirect.
display_name
The application's display name
description
A description of the application that will be displayed to users
enabled
When enabled is true, OAuth2 and API requests will be accepted from this app. When false, all requests from this app will be refused. Setting disabled invalidates existing tokens.
group_id
If set, only Looker users who are members of this group can use this web app with Looker. If group_id is not set, any Looker user may use this app to access this Looker instance
tokens_invalid_before
lock
All auth codes, access tokens, and refresh tokens issued for this application prior to this date-time for ALL USERS will be invalid.
activated_users
Expand UserPublic definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
first_name
lock
First Name
last_name
lock
Last Name
display_name
lock
Full name for display (available only if both first_name and last_name are set)
avatar_url
lock
URL for the avatar image (may be generic)
url
lock
Link to get this item
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
409: Resource Already Exists
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link