Update Auth

Version 4.0.24.16

Update API Session

API Session Workspace

You can use this endpoint to change the active workspace for the current API session.

Only one workspace can be active in a session. The active workspace can be changed any number of times in a session.

The default workspace for API sessions is the "production" workspace.

All Looker APIs that use projects or lookml models (such as running queries) will use the version of project and model files defined by this workspace for the lifetime of the current API session or until the session workspace is changed again.

An API session has the same lifetime as the access_token used to authenticate API requests. Each successful API login generates a new access_token and a new API session.

If your Looker API client application needs to work in a dev workspace across multiple API sessions, be sure to select the dev workspace after each login.

Request

PATCH /session
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
body
Auth
Expand ApiSession definition...
can
object
Operations the current user is able to perform on this object
workspace_id
string
The id of active workspace for this session
sudo_user_id
string
The id of the actual user in the case when this session represents one user sudo'ing as another

Response

200: Auth

Datatype
Description
(object)
can
object
Operations the current user is able to perform on this object
workspace_id
string
The id of active workspace for this session
sudo_user_id
string
The id of the actual user in the case when this session represents one user sudo'ing as another

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples