Skip to content

List all SAML users

GET
/api/v4/groups/{id}/saml_users

Lists all SAML users for a specified top-level group. Use the page and per_page pagination parameters to filter the results.

id
required
One of:
string

The ID or URL-encoded path of the group

username
string
nullable

Return single user with a specific username.

search
string
nullable

Search users by name, email, username.

active
boolean
nullable

Return only active users.

blocked
boolean
nullable

Return only blocked users.

created_after
string format: date-time
nullable

Return users created after the specified time.

created_before
string format: date-time
nullable

Return users created before the specified time.

page
integer
default: 1 nullable

Current page number

Example
1
per_page
integer
default: 20 nullable

Number of items per page

Example
20

OK

Media type application/json
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
created_at
string
bio
string
location
string
linkedin
string
twitter
string
discord
string
website_url
string
github
string
job_title
string
pronouns
string
organization
string
bot
boolean
work_information
string
followers
string
following
string
is_followed
string
local_time
string
last_sign_in_at
string format: date-time
confirmed_at
string format: date-time
last_activity_on
string format: date-time
email
string
theme_id
integer
color_scheme_id
integer
projects_limit
integer
current_sign_in_at
string format: date-time
identities
object
provider
string
extern_uid
string
saml_provider_id
string
can_create_group
boolean
can_create_project
boolean
two_factor_enabled
boolean
external
boolean
private_profile
boolean
commit_email
string
preferred_language
string
shared_runners_minutes_limit
string
extra_shared_runners_minutes_limit
string
scim_identities
object
extern_uid
string
group_id
string
active
string
Example
{
"id": 1,
"username": "admin",
"public_email": "john@example.com",
"name": "Administrator",
"state": "active",
"avatar_url": "https://gravatar.com/avatar/1",
"avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
"custom_attributes": [
{
"key": "foo",
"value": "bar"
}
],
"web_url": "https://gitlab.example.com/root",
"last_sign_in_at": "2015-09-03T07:24:01.670Z",
"confirmed_at": "2015-09-03T07:24:01.670Z",
"last_activity_on": "2015-09-03T07:24:01.670Z",
"email": "john@example.com",
"theme_id": 2,
"color_scheme_id": 1,
"projects_limit": 10,
"current_sign_in_at": "2015-09-03T07:24:01.670Z",
"can_create_group": true,
"can_create_project": true,
"two_factor_enabled": true,
"private_profile": false,
"preferred_language": "en"
}

Bad Request

Not Found