QOqovery
Organization Enterprise Connection

Get enterprise connection

get/organization/{organizationId}/enterpriseconnection/{connectionName}

Request

Path parameters

organizationIdstring uuid required

Organization ID

connectionNamestring required

The name of the Organization's Enterprise Connection

Response

Get enterprise connection

default_rolestring required

The purpose of this default role is to be associated to your users if:

  • you choose to not expose your IDPs groups to the SAML / OIDC connection
  • no associated group is found in your group_mappings defined

You can define either a Qovery provided role (i.e viewer) or one of your custom role`s uuid.

enforce_group_syncboolean required
  • if true, roles will be synchronized at each user login according to your group_mappings configuration based on your IDP groups
  • if false, no synchronization is done for your users and group_mappings configuration will be ignored
group_mappingsobject required

This will allow to create mapping rules based on your IDP group names.
It's a dictionnary having:

  • key: either a Qovery provided role (i.e viewer) or one of your custom role`s uuid
  • value: an array of your IDP group names

Example: "I want to associate the Qovery role devops to my IDP groups ['Administrators', 'DevSecOps']"

Changes

No recorded changes to this operation across all 1 revision of this API.