Get SAML Server

Select

SaaS

Customer Managed

Gets details of SAML app based on SAML app name

Path Parameters

• name string required

  name of SAML app

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• name string

  SAML app name.

• appKey string

  Unique key for the SAML app

• description string

  SAML app description

• enabled boolean

  Boolean to indicate whether SAML is enabled.

• autoCreateUser boolean

  This auto-creates non-existing user if the user detail match with the identity rule.

• type identityServerType

  Possible values: [SAML, ACTIVE_DIRECTORY, APPLE_DIRECTORY_SERVICE, ORACLE_DIRECTORY, OPEN_LDAP, LDAP_SERVER, OTHER]

  Identity server service type in Enum string

• userGroups object[]

  By default, CommCell users will not be associated with any group. Add a mapping to override this behaviour. Users will be associated with the specified group.

  companyInfo object

  id int32

  name string

  userGroupInfo object

  id int32

  name string
• nameIDAttribute string

  nameID in SAML assertion subject is used to perform login.

• userGroup object

  By default, auto-created users of a company will be associated to the Tenant Users group of the company. Add mapping to override this behaviour for a company.

  id int32

  name string
• createdForCompany object

  Details of the company for which the SAML app is created. This will only be present if the SAML app is under a company.

  id int32

  name string
• samlTestSummary SAMLTestStatus

  Possible values: [TEST_SUCCEEDED, NOT_TESTED]

  SAML Test Status Types

• attributeMappings object[]

  attribute mapping details

  customAttribute SAMLCustomAttributes

  Possible values: [COMPANY_NAME, EMAIL, SID, USER_GROUPS, USER_GUID, USER_NAME]

  SAML custom attribute types

  SAMLAttribute string

  SAML attribute

• identityProviderMetaData object

  SAML Identity provider meta data response

  entityId string

  Identity provider entity ID

  redirectUrl string

  Identity provider redirect URL

  logoutUrl string

  Identity Provider logout URL

• serviceProviderMetaData object

  entityId string

  Service provider endpoint/entity ID

  spAliases string[]

  Service provider endpoint URL list.

  singleSignOnUrl string

  single sign on URL

  singleLogoutUrl string

  single logout URL

• associations object

  emailSuffixes string[]

  Email suffixes associated with SAML

  companies object[]

  Companies associated with SAML app

  id int32

  name string

  domains object[]

  Domains associated with SAML app

  id int32

  name string

  userGroups object[]

  user groups associated with SAML app

  id int32

  name string

  users object[]

  users associated with SAML app

  id int32

  name string

{
  "name": "string",
  "appKey": "string",
  "description": "string",
  "enabled": true,
  "autoCreateUser": true,
  "userGroups": [
    {
      "companyInfo": {
        "id": 0,
        "name": "string"
      },
      "userGroupInfo": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "nameIDAttribute": "string",
  "userGroup": {
    "id": 0,
    "name": "string"
  },
  "createdForCompany": {
    "id": 0,
    "name": "string"
  },
  "attributeMappings": [
    {
      "customAttribute": "COMPANY_NAME",
      "SAMLAttribute": "string"
    }
  ],
  "identityProviderMetaData": {
    "entityId": "string",
    "redirectUrl": "string",
    "logoutUrl": "string"
  },
  "serviceProviderMetaData": {
    "entityId": "string",
    "spAliases": [
      "string"
    ],
    "singleSignOnUrl": "string",
    "singleLogoutUrl": "string"
  },
  "associations": {
    "emailSuffixes": [
      "string"
    ],
    "companies": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "domains": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "userGroups": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "users": [
      {
        "id": 0,
        "name": "string"
      }
    ]
  }
}

{
  "name": "appname",
  "appKey": ".......",
  "description": "SAML app description",
  "enabled": true,
  "autoCreateUser": true,
  "type": "SAML",
  "createdForCompany": {
    "id": 102,
    "name": "companyname"
  },
  "userGroups": [
    {
      "companyInfo": {
        "id": 0,
        "name": "CommCell"
      },
      "userGroupInfo": {
        "id": 1234,
        "name": "usergroupname"
      }
    }
  ],
  "nameIDAttribute": "User Principal Name",
  "samlTestSummary": {
    "status": "TEST_SUCCEEDED"
  },
  "attributeMappings": [
    {
      "customAttribute": "Email",
      "SAMLAttribute": "email"
    },
    {
      "customAttribute": "SID",
      "SAMLAttribute": "sid"
    },
    {
      "customAttribute": "user name",
      "SAMLAttribute": "username"
    },
    {
      "customAttribute": "full name",
      "SAMLAttribute": "fullname"
    },
    {
      "customAttribute": "user guid",
      "SAMLAttribute": "userguid"
    },
    {
      "customAttribute": "user groups",
      "SAMLAttribute": "usergroups"
    },
    {
      "customAttribute": "company name",
      "SAMLAttribute": "companyname"
    }
  ],
  "identityProviderMetaData": {
    "entityId": "http://www.idp-domain.com/.......",
    "redirectUrl": "https://idp-domain.com/app/....../sso/saml",
    "logoutUrl": "https://idp-domain.com/app/......./slo/saml"
  },
  "serviceProviderMetaData": {
    "entityId": "https://commvault-hostname:443/identity",
    "singleSignOnUrl": "https://commvault-hostname:443/identity/samlAcsIdpInitCallback.do?samlAppKey=......",
    "singleLogoutUrl": "https://commvault-hostname:443/identity/server/SAMLSingleLogout?samlAppKey=.......",
    "spAliases": [
      "https://commvault-hostname1:443/identity",
      "https://commvault-hostname2:443/identity"
    ]
  },
  "associations": {
    "emailSuffixes": [
      "email.com"
    ],
    "companies": [
      {
        "id": 111,
        "name": "companyname"
      }
    ],
    "domains": [
      {
        "id": 222,
        "name": "domainname",
        "serviceType": 2
      }
    ],
    "userGroups": [
      {
        "id": 333,
        "name": "groupname"
      }
    ],
    "users": [
      {
        "id": 444,
        "name": "username"
      }
    ]
  }
}

GET /v4/saml/:name    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

name — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/SAML/:name' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/SAML/:name' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/SAML/:name' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/SAML/:name' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/SAML/:name' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/SAML/:name' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/SAML/:name' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'