Veeam Service Provider Console 9.1
REST API Reference
Related documents

Single Sign On

This resource collection represents Single Sign-on parameters.

Get All Identity Providers

Returns a collection resource representation of all identity providers.

Request
query Parameters
Array of objects or null (FilterParameter)

Specifies the conditions that a resource must meet to be returned in the output.

Array of objects or null (SortParameter)

Specifies the order in which resources are returned from the collection.

limit
integer <int32> [ 1 .. 500 ]
Default: 100

Specifies the first N resources that must be returned in the output.

offset
integer <int32> [ 0 .. 2147483647 ]
Default: 0

Excludes the first N resources from the query output.

Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Request-id
string <uuid>

Random UID that you can assign to a request for idempotence and async action progress tracking.

Note that an operation is idempotent only during 5 minute time interval.

Example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.6.1
Responses
200

OK

202

Request has been queued for execution.

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.

get/organizations/identityProviders
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Check Uniqueness of Identity Provider Name.
Checks whether the specified name of an identity provider is unique.


Request 
query Parameters
name
required
string  [ 5 .. 32 ] characters ^[\._a-zA-Z0-9]+$
Identity provider name.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
The true value indicates that the identity provider name is unique. The false value insicates that the identity provider name is already taken.


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/organizations/identityProviders/name
Request samples 
Response samples 
application/json
{
  • "data": true
}
Get All Identity Providers of Organization
Returns a collection resource representation of all identity providers managing user identities of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/{organizationUid}/identityProviders
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create SAML2 Identity Provider
Creates a new SAML2 identity provider.




Before you create a new SAML2 identity provider for a company you must generate a company portal URL.




Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
required
object (Saml2Configuration) 
Represents the <sustainsys.saml2> element of SAML2 configuration. For details, see the Sustainsys.Saml2 documentation.


 
displayName
required
string  [ 2 .. 56 ] characters ^[^\<\>\"\'\%\;\(\)\&\^\+\|]+$
Display name of an identity provider.


 
name
required
string  [ 5 .. 32 ] characters ^[\._a-zA-Z0-9]+$
Name of an identity provider.


 
template
string (IdentityProviderTemplate) 
 Default:  "Custom"
Identity provider template.


 Enum: "Unknown" "Keycloak" "ADFS" "Okta" "Custom"  
configurationCompleted
boolean
 Default:  false
Indicates whether the identity provider configuration is completed.




If configuration is not completed, an identity provider is not available on the authorization screen of the Veeam Service Provider Console web interface.
You can complete configuration by modifying this property using the PATCH operation.
If another identity provider is already enabled for an organization, this value cannot be modified.




 
enabled
boolean
 Default:  true
Indicates whether an identity provider is enabled.


 
Responses 
200
Resource representation of a created identity provider.


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/organizations/{organizationUid}/identityProviders/saml2
Request samples 
application/json
{
  • "name": "MyCompany",
  • "displayName": "MyCompany",
  • "template": "Keycloak",
  • "configuration": {
    },
  • "configurationCompleted": true,
  • "enabled": true
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Mapping Rules of All Organization Identity Providers
Returns a collection resource representation of mapping rules configured for all identity providers of an organization with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
query Parameters
expand
Array of strings (IdentityProviderRoleMappingRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "IdentityProvider"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/{organizationUid}/identityProviders/rules
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Mapping Rules
Returns a collection resource representation of all mapping rules.


Request 
query Parameters
expand
Array of strings (IdentityProviderRoleMappingRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "IdentityProvider"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/identityProviders/rules
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Mapping Rules of Organization Identity Provider
Returns a collection resource representation of mapping rules configured for an organization identity provider with the specified name.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
query Parameters
expand
Array of strings (IdentityProviderRoleMappingRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "IdentityProvider"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/{organizationUid}/identityProviders/{identityProviderName}/rules
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Mapping Rule for Organization Identity Provider
Creates mapping rule for an organization identity provider with the specified name.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
name
required
string  [ 1 .. 50 ] characters 
Name of a mapping rule. Each mapping rule configured for a single identity provider must have a unique name.


 
role
required
string
User role.


 Enum: "Unknown" "PortalAdministrator" "PortalOperator" "PortalReadonlyOperator" "CompanyLocationUser" "CompanyLocationAdministrator" "CompanyOwner" "CompanyAdministrator" "CompanyInvoiceAuditor" "ResellerOwner" "ResellerOperator" "ResellerUser" "ResellerInvoiceAuditor" "ResellerAdministrator" "CompanyTenant"  
organizationMappingSourceClaimType
required
string  [ 1 .. 2048 ] characters 
Organization mapping claim type containing organization alias.


 
description
string or null  [ 1 .. 500 ] characters 
Mapping rule description.


 
enabled
boolean
 Default:  true
Indicates whether a mapping rule is enabled.


 
managedCompaniesUids
Array of strings or null <uuid> 
Array of UIDs assigned to companies managed by a user.




Required for the PortalOperator, PortalReadonlyOperator, ResellerOperator, ResellerUser 
and ResellerAdministrator user roles.




 
manageAllCompanies
boolean
 Default:  true
Indicates whether a user must manage all available companies. Overrides values of the managedCompaniesUids property.


 
hasAccessToProvider
boolean or null
Indicates whether a user is permitted to view service provider organization resources.




Required for the PortalOperator and PortalReadonlyOperator user roles.




 
locationsMappingSourceClaimType
string or null  [ 1 .. 2048 ] characters 
Location mapping claim containing user locations in the following format: Location1;Location2.




This property can be specified for the CompanyLocationUser, CompanyLocationAdministrator and CompanySubtenant user roles. Otherwise a user is assigned to the first available company location.




 
object or null (IdentityProviderCompanyTenantMappingParameters) 
Parameters required to create a mapping rule for users with CompanyTenant role.


 
Array of objects or null (IdentityProviderClaimMatchRule) 
Array of additional mappings required for rule selection.


 
Array of objects or null (IdentityProviderAttributeMapping) 
Array of mapping claims attributed to user parameters.


 
object or null
Resource representation of the related identity provider entity.


 
Responses 
200
Created mapping rule.


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/organizations/{organizationUid}/identityProviders/{identityProviderName}/rules
Request samples 
application/json
{
  • "name": "PortalOperator",
  • "description": "Portal Operator Keycloak",
  • "role": "PortalOperator",
  • "enabled": true,
  • "managedCompaniesUids": null,
  • "manageAllCompanies": true,
  • "hasAccessToProvider": true,
  • "organizationMappingSourceClaimType": "Company",
  • "locationsMappingSourceClaimType": null,
  • "companyTenantMappingClaims": null,
  • "additionalMappings": null,
  • "attributeMappings": null,
  • "_embedded": null
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Organization Identity Provider Mapping Rule
Returns a resource representation of an organization identity provider mapping rule with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
ruleUid
required
string <uuid> 
Mapping rule UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/{organizationUid}/identityProviders/{identityProviderName}/rules/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Organization Identity Provider Mapping Rule
Modifies an organization identity provider mapping rule with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
ruleUid
required
string <uuid> 
Mapping rule UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/organizations/{organizationUid}/identityProviders/{identityProviderName}/rules/{ruleUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Organization Identity Provider Mapping Rule
Deletes an organization identity provider mapping rule with the specified UID.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
ruleUid
required
string <uuid> 
Mapping rule UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/organizations/{organizationUid}/identityProviders/{identityProviderName}/rules/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Organization Identity Provider
Returns a resource representation of an organization identity provider with the specified name.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/{organizationUid}/identityProviders/{identityProviderName}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Organization Identity Provider
Modifies an organization identity provider with the specified name.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/organizations/{organizationUid}/identityProviders/{identityProviderName}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Organization Identity Provider
Deletes an organization identity provider with the specified name.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/organizations/{organizationUid}/identityProviders/{identityProviderName}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Revalidate Organization Identity Provider
Revalidates an organization identity provider with the specified name.


Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/organizations/{organizationUid}/identityProviders/{identityProviderName}/revalidate
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Metadata for Organization Identity Provider.
Returns content of the metadata XML file that is sent to an organization identity provider.




Error response is returned in the JSON format.




Request 
path Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
identityProviderName
required
string  non-empty 
Identity provider name.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/{organizationUid}/identityProviders/saml2/{identityProviderName}/metadata
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}

    
    

                                

                                    
Document updated 11/06/2025
Page content applies to build 9.1.0.30345