Get OpenId Connect app

Select

SaaS

Customer Managed

Gets details of OpenID Connect app based on OpenID Connect app name

Path Parameters

• name string required

  name of OpenId Connect app

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• name string

  OpenID Connect app name.

• appKey string

  Unique key for the OpenIdConnect app

• description string

  OpenIdConnect app description

• enabled boolean

  Boolean to indicate whether OpenID Connect is enabled.

• type string

  Possible values: [OPENIDCONNECT]

  Must be 'OPENIDCONNECT'

• identityProviderMetaData object

  OpenID Connect Identity provider meta data response

  clientId string

  Identity provider client ID

  discoveryEndpointUrl string

  Identity provider discovery endpoint URL

• associations object

  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,
  "type": "OPENIDCONNECT",
  "identityProviderMetaData": {
    "clientId": "string",
    "discoveryEndpointUrl": "string"
  },
  "associations": {
    "companies": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "domains": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "userGroups": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "users": [
      {
        "id": 0,
        "name": "string"
      }
    ]
  }
}

{
  "name": "appname",
  "appKey": ".......",
  "description": "OpenId Connect app description",
  "enabled": true,
  "autoCreateUser": false,
  "type": "OPENIDCONNECT",
  "identityProviderMetaData": {
    "clientId": "e3266d2b-1111-bbbb-aaaa-827d10ffffff",
    "discoveryEndpointUrl": "https://login.microsoftonline.com/3b92c35e-1111-2222-3333-4444555591d0/v2.0/.well-known/openid-configuration"
  },
  "associations": {
    "companies": [
      {
        "id": 111,
        "name": "companyname"
      }
    ],
    "domains": [
      {
        "id": 222,
        "name": "domainname",
        "serviceType": 2
      }
    ],
    "userGroups": [
      {
        "id": 333,
        "name": "groupname"
      }
    ],
    "users": [
      {
        "id": 444,
        "name": "username"
      }
    ]
  }
}

Loading...