groups

List all SAML users

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

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

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idinteger required

Query parameters

usernamestring

Return single user with a specific username.

searchstring

Search users by name, email, username.

activeboolean

Return only active users.

blockedboolean

Return only blocked users.

created_afterstring date-time

Return users created after the specified time.

created_beforestring date-time

Return users created before the specified time.

pageinteger

Current page number

per_pageinteger

Number of items per page

Response

List all SAML users

idinteger required
usernamestring required
public_emailstring required
namestring required
statestring required
lockedboolean required
avatar_urlstring required
avatar_pathstring
web_urlstring required
created_atstring
biostring required
locationstring required
linkedinstring required
twitterstring required
discordstring required
website_urlstring required
githubstring required
job_titlestring required
pronounsstring required
organizationstring required
botboolean required
work_informationstring required
followersstring
followingstring
is_followedstring
local_timestring required
last_sign_in_atstring date-time required
confirmed_atstring date-time required
last_activity_onstring date-time required
emailstring required
theme_idinteger required
color_scheme_idinteger required
projects_limitinteger required
current_sign_in_atstring date-time required
can_create_groupboolean required
can_create_projectboolean required
two_factor_enabledboolean required
externalboolean required
private_profileboolean required
commit_emailstring required
preferred_languagestring required
shared_runners_minutes_limitstring required
extra_shared_runners_minutes_limitstring required

Example response

[
  {
    "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,
    "preferred_language": "en"
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.