Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Configurations

Name

Type

Description/Value

name

STRING

REQUIRED

The display name for the app registration.

Example"name": "NCD Workload Management Service API DEV"

identifierUris

[STRING]

The globally unique URI used to identify this web API. It is the prefix for scopes and in access tokens, it is the value of the audience claim. Also referred to as an identifier URI.

Example"identifierUris": [ "https://034gc.onmicrosoft.com/ncd-wms-dev", "api://CBDD9546-2A15-477B-A2BC-14A5702E6797" ]

owners

[STRING]

Users that can view and edit the application registration.

Example

"owners": [
      "walter.hoban@tc.gc.ca",
      "ivan.neganov@tc.gc.ca"
]

requiresAssignedUsers

BOOLEAN

Only users assigned to this application are allowed to access it.

Functions only with the following application types:

  • Federated Single Sign-on with SAML-based Authentication

  • Application proxy applications that use the Azure Active Directory Pre-Authorization

  • Applications build directly on the Azure AD application platform and use the OAuth 2.0 / OpenID Connect Authentication

Example

"requiresAssignedUsers": false

logoutUrl

STRING

Front-channel logout URL, used as a destination URL to where a user is redirected after logging out to clear the session data.

Example

"logoutUrl": "https://vessel-eregistry-dev.tc.gc.ca/signout-oidc"

oAuth2PermissionsFile

STRING

Example

"oAuth2PermissionsFile": "Permissions\\wms\\ncd-oauth2-permissions.json"

appRolesFile

STRING

replyUrls

[STRING]

requiredResourceAccessFile

STRING

certificateAndSecrets

[OBJECT]

oauth2AllowImplicitFlow

BOOLEAN

oauth2AllowIdTokenImplicitFlow

BOOLEAN

keyVaultEntries

[OBJECT]

Permissions

Name

Type

Description/Value

adminConsentDescription

STRING

REQUIRED

adminConsentDisplayName

STRING

REQUIRED

id

GUID

isEnabled

BOOLEAN

REQUIRED

type

STRING

REQUIRED

userConsentDescription

STRING

REQUIRED

userConsentDisplayName

STRING

REQUIRED

value

STRING

REQUIRED

Resource Access

Name

Type

Description/Value

appName

STRING

REQUIRED

type

STRING

REQUIRED

requiredPermissions

ARRAY

REQUIRED

Roles

Name

Type

Description/Value

allowedMemberTypes

[STRING]

REQUIRED

description

STRING

REQUIRED

displayName

STRING

REQUIRED

id

GUID

isEnabled

BOOLEAN

REQUIRED

value

STRING

REQUIRED

users

[STRING]

groups

[STRING]

  • No labels