Quickstart
API Reference
curl --request GET \
--url https://api.select.dev/api/{organization_id}/users \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "<string>",
"name": "<string>",
"email_address": "<string>",
"identity_provider": "<string>",
"picture": "<string>",
"last_login_sso_groups": [
"<string>"
],
"num_pages_visited_last_2_months": 123,
"last_login_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z",
"roles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"role": "admin",
"entity": {
"type": "team",
"id": "<string>",
"display_name": "<string>",
"usage_group_details": {
"set_name": "<string>",
"group_name": "<string>"
}
},
"organization_id": "<string>",
"email_address": "<string>",
"sso_group_name": "<unknown>",
"granted_to_team_name": "<unknown>",
"is_default": false
}
]
}
],
"remaining_count": 123,
"limit": 123,
"offset": 123
}List users
Retrieve all users in an organization with pagination.
curl --request GET \
--url https://api.select.dev/api/{organization_id}/users \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "<string>",
"name": "<string>",
"email_address": "<string>",
"identity_provider": "<string>",
"picture": "<string>",
"last_login_sso_groups": [
"<string>"
],
"num_pages_visited_last_2_months": 123,
"last_login_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z",
"roles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"role": "admin",
"entity": {
"type": "team",
"id": "<string>",
"display_name": "<string>",
"usage_group_details": {
"set_name": "<string>",
"group_name": "<string>"
}
},
"organization_id": "<string>",
"email_address": "<string>",
"sso_group_name": "<unknown>",
"granted_to_team_name": "<unknown>",
"is_default": false
}
]
}
],
"remaining_count": 123,
"limit": 123,
"offset": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
1 <= x <= 1000x >= 0Response
Successful Response
Response model for listing users with pagination metadata.
List of users
Show child attributes
Show child attributes
- UserRoleEmailGet
- UserRoleSSOGroupGet
- UserRoleDefaultGet
- UserRoleTeamGet
Show child attributes
Show child attributes
admin, editor, monitor_editor, viewer Permission entity with a human readable display name.
Args:
type: The type of the entity. usage_group, snowflake_account,
snowflake_organization, or select_organization.
id: The id of the entity. The usage_group_id, snowflake_account_uuid,
snowflake_organization_name, or organization_id.
display_name: A human readable name for the entity. Typically colon delimited.
On this class the property is required.
usage_group_details: Optional details about the usage group. Only included in
serialization when type is USAGE_GROUP.
Note that the hashing and equality check are done based on the type and id fields
as per the PermissionEntity class. This means that even if the display_name is
different, two PermissionEntityWithDisplayName instances will still compare equal.
Show child attributes
Show child attributes
The type of the permission entity.
Comparison operations are supported to understand the level in the hierarchy of the type.
NOTE: The object hierarchy is not linear. SELECT Organisations are still at the top, but teams and usage groups are effectively the same level, but will return false if compared.
team, usage_group, snowflake_account, snowflake_organization, select_organization true, false Number of users remaining after pagination
Maximum number of items returned
Number of items skipped