Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configure the designer.json file that is in the <EMM_HOME>/repository/deployment/server/jaggeryapps/portal/configs directory as follows:

  1. Configure <ServerRoles> that is in the <EMM_HOME>/repository/conf/carbon.xml file by adding the CDMFPlatform role.

    Code Block
    <ServerRoles>
       <Role>EMMPlatform</Role>
       <Role>CDMFPlatform</Role>
    </ServerRoles>
  2. If you have enabled SSO for WSO2 EMM, you need to define sso as the value for activeMethod under authorization else, you can define the activeMethod as basic.
    Example: WSO2 EMM configured for SSO.

    Code Block
    "authentication":{  
       "activeMethod":"sso",
       "methods":{  
          "sso":{  
             "attributes":{  
                "issuer":"portal",
                "identityProviderURL":"https://localhost:9443/samlsso",
                "responseSigningEnabled":"false",
                "acs":"https://localhost:9444/portal/acs",
                "identityAlias":"wso2carbon",
                "useTenantKey":false
             }
          },
          "basic":{  
             "attributes":{  
    
             }
          }
       }
    }
  3. Configure the authorization attributes in the designer.json file.

    Code Block
      "authorization":{  
       "activeMethod":"oauth",
       "methods":{  
          "oauth":{  
             "attributes":{  
                "idPServer":"%https.ip%/oauth2/token",
                "dynamicClientProperties":{  
                   "callbackUrl":"%https.ip%/portal",
                   "clientName":"portal",
                   "owner":"admin",
                   "applicationType":"JaggeryApp",
                   "grantType":"password refresh_token urn:ietf:params:oauth:grant-type:saml2-bearer",
                   "saasApp":false,
                   "dynamicClientRegistrationEndPoint":"%https.ip%/dynamic-client-web/register/",
                   "tokenScope":"Production"
                }
             }
          }
       }
    }
    PropertyDescriptionData
    Type 
    Example
    activeMethodDefine the method that needs to be made active from the available authorization methods. In this case you need to define the active mode as OAuth.YesStringOAuth
    idPServer

    Define the Identity Provider URL by replacing %https.ip% with https://<EMM_HOST>:<EMM_PORT>.

    Info

    The default value for <EMM_HOST> is localhost and if you have not port offset WSO2 EMM, the default <EMM_PORT> is 9443.

    YesString
    localhost:9443/oauth2
    /token
    callbackURL

    Define the call back URL by replacing %https.ip% with the https://<EMM_HOST>:<EMM_PORT>.

    Info

    The default value for <EMM_HOST> is localhost and if you have not port offset WSO2 EMM, the default <EMM_PORT> is 9443.

    YesString
    https.ip%/portal
    clientNameDefine the OAuth application name.YesString
    portal
    ownerDefine the username of the owner of the application. In this use case it is the administrator.YesString
    admin
    applicationTypeThe default application type is a jaggery application. If you wish to change it, you need to update this field with the respective application type.YesString
    JaggeryApp
    grantTypeIn this use case, out of the six OAuth 2.0 grant types WSO2 EMM uses the password refresh_token and the saml2-bearer grant types. You can add more grant types as space separated values. If you configured WSO2 EMM for SSO authentication, the saml2-bearer grant type will be used and if you configured WSO2 EMM for basic authentication, the password refresh_token grant type will be used.YesString
    password
    saasAppDefine if this application is a Software as a Service (SaaS) application or not, by defining true or false as the respective values.YesBooleanfalse

    dynamicClientRegistrationEndPoint

    Define the dynamic client registration endpoint by replacing %https.ip% with the https://<EMM_HOST>:<EMM_PORT>.

    Info

    The default value for <EMM_HOST> is localhost and if you have not port offset WSO2 EMM, the default <EMM_PORT> is 9443.

    YesString
    %https.ip%/dynamic-client
    -web/register/
    tokenScopeDefine the scope of the issued access token. It is used to limit the authorization granted to the client by the resource owner.YesString
    Production

...