Users and Groups

Applies to: FotoWare 8.0 Feature Release 4

13. May 2025

Table of Contents

Features When to use the Users and Groups API Example: Custom Authentication Provider How to use the Users and Groups API Article type: Reference

Note: This API will soon be deprecated. More information about this will be available in a separate deprecation notice.
Information about our new User Management API will soon be available here on Learn and on api.fotoware.com.

The users and groups API is for querying and managing users and groups in FotoWeb. It allows API clients to programmatically add and modify users and groups, search for users and groups, and extract information about them. Custom authentication providers can also use it to import users from third-party directory services.

This is an administrative API and is only available when server-to-server authentication is used. Impersonated users and guests do not have access to users and groups, not even read access.

Features

The users and groups API allows API clients to do the following:

Create a new user
Read information of a single user or a query result with multiple users
List users on the site
Search for users
Delete a user
Import a user from a third-party directory service and create or update the user on demand
Add users to a group
Remove users from a group
Create a new group
Read information of a single group or a query result with multiple groups
List groups on the site
Search for groups
Delete a group

When to use the Users and Groups API

The users and groups API can be used to register users on a FotoWeb site in a custom way, for example, through a custom user registration service, a custom authentication provider, a synchronization service, or a simple script that imports users to FotoWeb from a third-party directory service such as Microsoft Active Directory. The custom authentication provider or user registration or synchronization service then acts as a client of the user and groups API.

Example: Custom Authentication Provider

FotoWeb redirects a user to the custom authentication provider with a login page.
The user provides credentials for a third-party system (e.g., a Microsoft Active Directory Domain) or is automatically authenticated using Single sign-on (SSO) mechanism.
The custom authentication provider uses the users and groups API to import or synchronize the user
The user is redirected back to FotoWeb with an authentication token.

How to use the Users and Groups API

At first, the client needs to be authenticated as administrator. This is done using server-to-server authentication.

Then, use the private API entry point to request the full API descriptor.

In the full API descriptor, the following attributes contain the URLs of the entry points of the user and groups API:

users: URL of the global user list containing all users on the site
groups: URL of the global group list containing all groups on the site

Article type: Reference

Group List Representation Describes the JSON representation of a list of groups.
Group Representation Describes the JSON representation of a group.
Member List Representation
User Link List Representation Describes a JSON data format for specifying a list of users by only their URLs and no additional information.
User List Representation Describes the JSON representation of a list of users.
User Representation Describes the JSON representation of a user.