Citrixonline

SCIM

The SCIM API lets you manage users in your organization. You can then automate the provisioning of product licenses for these users, and they can use your…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The SCIM API lets you manage users in your organization. You can then automate the provisioning of product licenses for these users, and they can use your company's Single Sign-On solution through an Identity Provider.

Endpoints 17

Users

  • GETGet Users/Users?filter=stringQueries multiple user identities in the organization domain. Filtering is available.
  • POSTCreate User/UsersCreates a new organization user and adds them to the user domain. The user email domain must match an existing organization email domain.
  • GETGet Current User/Users/meQueries the identity of the current authenticated user.
  • PUTReplace Current User/Users/meChanges the current authenticated user's displayName, locale, timezone, username and password. The request must include the full user definition (to modify…
  • PATCHUpdate Current User/Users/meChanges a limited set (or all if you choose) of the current authenticated user's data. The updated user email domain must be an existing organization email…
  • GETGet User/Users/:userKeyQueries user identity in the organization domain.
  • PUTReplace User/Users/:userKeyChanges an existing user's displayName, locale, timezone, username and password. The request must include the full user definition (to modify one or more…
  • DELETEDelete User/Users/:userKeyDeletes a user from the organization (but not from the account).
  • PATCHUpdate User/Users/:userKeyChanges a limited set (or all if you choose) of the user's data. The updated user email domain must be an existing organization email domain.

Groups

  • GETGet Groups/Groups?filter=stringQueries multiple group identities in the organization domain. Filtering, sorting and pagination are available. This call requires the role ROLE_ORG_READ.
  • POSTCreate Group/GroupsCreates a new organization group and adds it to the user domain. Member groups and member users must be in the organization. This call requires the role…
  • GETGet Group/Groups/:groupKeyQueries group details in the organization domain. This call requires the role ROLE_ORG_READ.
  • PUTReplace Group/Groups/:groupKeyUpdates an existing group. The request must include the full group definition. To modify one or more values without sending the full definition, see "Update…
  • DELETEDelete Group/Groups/:groupKeyDeletes a group from the organization (but not from the account). The group must be in the organization. This call requires the role ROLE_ORG_WRITE.
  • PATCHUpdate Group/Groups/:groupKeyUpdates one or more values of an existing group without sending the full definition. Member groups and member users must be in the organization. This call…

Schemas

  • GETGet User Schema/Schemas/UsersQueries the user schema. The user schema is defined in SCIM Core Schema (http://www.simplecloud.info/specs/draft-scim-core-schema-01.html#resource-schema).
  • GETGet Service Provider Configurations/ServiceProviderConfigsQueries service provider configurations. The service provider configurations are defined in SCIM Core Schema…

API details

Base URL
https://api.citrixonline.com/identity/v1
Authentication
None declared in the description
Operations
17 operations on 7 pathsGET 7PUT 3PATCH 3POST 2DELETE 2
Main resources
Users 9Groups 6Schemas 2
Response formats
application/json
Description format
Swagger 2.0, API version N/A
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the SCIM in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the SCIM collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get Users” (GET /Users?filter=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the SCIM?

The SCIM API lets you manage users in your organization. You can then automate the provisioning of product licenses for these users, and they can use your… It is listed under Other and has 17 endpoints.

Who publishes the SCIM?

It is listed from Citrixonline's public API description (an OpenAPI document), not published by Citrixonline on Swastik Codes. Anyone who controls citrixonline.com can claim the profile by adding a DNS TXT record.

What is the base URL of the SCIM?

Requests go to https://api.citrixonline.com/identity/v1. Endpoint paths are added to this base URL.

How do I authenticate with the SCIM?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the SCIM have?

17 operations on 7 paths (7 GET, 3 PUT, 3 PATCH, 2 POST, 2 DELETE). The largest groups are Users, Groups, Schemas.

Is forking the SCIM free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.