Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Get Own Current Scope

GET
/iam/v1/users/me/scope
curl --request GET \
--url https://example.com/iam/v1/users/me/scope

Returns the scope the caller works in: the most recent scope in their recent scopes they can still enter, otherwise the scope of their most recently granted role. Absent when they hold no organisation, workspace or group role.

OK

Media type application/json

Scope Selection

Where the caller works now. The scopes they worked in recently are listed by ListRecentScopes. Scopes are named by identifier only; resolve names from the organisation, workspace and group services.

object
current_scope

The scope the caller works in now. Absent when the caller holds no organisation, workspace or group role they can enter.

object
scope_type

The kind of scope: organisation, workspace or group. Never PLATFORM.

string format: enum Output only
Allowed values: SCOPE_TYPE_UNSPECIFIED SCOPE_TYPE_WORKSPACE SCOPE_TYPE_GROUP SCOPE_TYPE_ORGANISATION SCOPE_TYPE_PLATFORM
scope_id

The scope’s identifier.

stringOutput only
visit_time

When the caller last switched into this scope. Absent when they never did: the scope of their most recently granted role, offered as a starting point.

string format: date-time Output only
Example
{
"current_scope": {
"scope_type": "SCOPE_TYPE_UNSPECIFIED"
}
}

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}