> For the complete documentation index, see [llms.txt](https://docs.navigaglobal.com/navigaid/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.navigaglobal.com/navigaid/services/admin-api/routes/organizations.md).

# Organizations

## /organizations.export

<mark style="color:blue;">`GET`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.export`

Get organization by id

#### Query Parameters

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.get

<mark style="color:blue;">`GET`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.get`

Get organization by id

#### Query Parameters

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "id": "Organization id",
  "name": "infomaker",
  "displayName": "Infomaker Scandinavia AB",
  "wellKnownConfigUrl": "http://example.com/.well-known.json",
  "scope": "openid profile email",
  "clientId": "foobarbaz",
  "responseMode": "query",
  "groupsClaim": "Groups",
  "whitelistCallbackUrls": "[\"infomaker.io\", \"infomaker-test.io\"]",
  "sanitizedClientSecret": "null",
  "forceLoginPrompt": false,
  "useUserinfoEndpoint": false,
  "blocked": false,
  "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.list

<mark style="color:blue;">`GET`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.list`

List organizations

#### Path Parameters

| Name | Type   | Description |
| ---- | ------ | ----------- |
|      | string |             |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
[
  {
    "id": "Organization id",
    "name": "infomaker",
    "displayName": "Infomaker Scandinavia AB",
    "wellKnownConfigUrl": "http://example.com/.well-known.json",
    "scope": "openid profile email",
    "clientId": "foobarbaz",
    "responseMode": "query",
    "groupsClaim": "Groups",
    "whitelistCallbackUrls": "[\"infomaker.io\", \"infomaker-test.io\"]",
    "sanitizedClientSecret": "null",
    "forceLoginPrompt": false,
    "useUserinfoEndpoint": false,
    "blocked": false,
    "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
  }
]
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.listGroupToRoleMappings

<mark style="color:blue;">`GET`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.listGroupToRoleMappings`

List group to service role mappings by organization id

#### Query Parameters

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
[
  {
    "roleId": "Role id",
    "unitId": "Unit id",
    "organizationId": "Organization id",
    "group": "Auth team"
  }
]
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.block

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.block`

Block organization by id

#### Request Body

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |

{% tabs %}
{% tab title="204 No Content" %}

```javascript
""
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.create

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.create`

Create organization

#### Request Body

| Name                  | Type    | Description                          |
| --------------------- | ------- | ------------------------------------ |
| name                  | string  | Organization name                    |
| displayName           | string  | Organization display name            |
| wellKnownConfigUrl    | string  | undefined                            |
| scope                 | string  | OIDC scope                           |
| clientId              | string  | OIDC client ID                       |
| responseMode          | string  | OIDC response mode                   |
| groupsClaim           | string  | Organization groups claim            |
| whitelistCallbackUrls | array   | An array with callback whitelist URL |
| clientSecret          | string  | undefined                            |
| forceLoginPrompt      | boolean | undefined                            |
| useUserinfoEndpoint   | boolean | undefined                            |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "id": "Organization id",
  "name": "infomaker",
  "displayName": "Infomaker Scandinavia AB",
  "wellKnownConfigUrl": "http://example.com/.well-known.json",
  "scope": "openid profile email",
  "clientId": "foobarbaz",
  "responseMode": "query",
  "groupsClaim": "Groups",
  "whitelistCallbackUrls": "[\"infomaker.io\", \"infomaker-test.io\"]",
  "sanitizedClientSecret": "null",
  "forceLoginPrompt": false,
  "useUserinfoEndpoint": false,
  "blocked": false,
  "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.delete

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.delete`

Delete organization by id

#### Request Body

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |

{% tabs %}
{% tab title="204 No Content" %}

```javascript
""
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.import

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.import`

Get organization by id

#### Request Body

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |
| config         | object | undefined       |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.logout

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.logout`

Logout organization by id

#### Request Body

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |

{% tabs %}
{% tab title="204 No Content" %}

```javascript
""
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setClientId

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setClientId`

Set organization clientId

#### Request Body

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |
| clientId       | string | OIDC client ID  |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "clientId": "foobarbaz"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setClientSecret

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setClientSecret`

Update org client secret

#### Request Body

| Name           | Type   | Description        |
| -------------- | ------ | ------------------ |
| organizationId | string | Organization id    |
| clientSecret   | string | OIDC client secret |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "sanitizedClientSecret": "foobarbaz"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setDisplayName

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setDisplayName`

Set organization display name

#### Request Body

| Name           | Type   | Description               |
| -------------- | ------ | ------------------------- |
| organizationId | string | Organization id           |
| displayName    | string | Organization display name |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "name": "Infomaker Scandinavia AB"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setForceLoginPrompt

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setForceLoginPrompt`

Set organization forceLoginPrompt

#### Request Body

| Name             | Type    | Description     |
| ---------------- | ------- | --------------- |
| organizationId   | string  | Organization id |
| forceLoginPrompt | boolean | undefined       |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "forceLoginPrompt": false
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setGroupsClaim

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setGroupsClaim`

Set organization groupsClaim

#### Request Body

| Name           | Type   | Description               |
| -------------- | ------ | ------------------------- |
| organizationId | string | Organization id           |
| groupsClaim    | string | Organization groups claim |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "groupsClaim": "Groups"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setName

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setName`

Set organization name

#### Request Body

| Name           | Type   | Description       |
| -------------- | ------ | ----------------- |
| organizationId | string | Organization id   |
| name           | string | Organization name |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "name": "infomaker"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setResponseMode

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setResponseMode`

Set organization responseMode

#### Request Body

| Name           | Type   | Description        |
| -------------- | ------ | ------------------ |
| organizationId | string | Organization id    |
| responseMode   | string | OIDC response mode |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "responseMode": "query"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setScope

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setScope`

Set organization scope

#### Request Body

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |
| scope          | string | OIDC scope      |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "scope": "openid profile email"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setUseUserinfoEndpoint

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setUseUserinfoEndpoint`

Set organization useUserinfoEndpoint

#### Request Body

| Name                | Type    | Description     |
| ------------------- | ------- | --------------- |
| organizationId      | string  | Organization id |
| useUserinfoEndpoint | boolean | undefined       |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "useUserinfoEndpoint": false
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setWellKnownConfigUrl

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setWellKnownConfigUrl`

Set organization wellKnownConfigUrl

#### Request Body

| Name               | Type   | Description                        |
| ------------------ | ------ | ---------------------------------- |
| organizationId     | string | Organization id                    |
| wellKnownConfigUrl | string | Organization well known config url |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "wellKnownConfigUrl": "http://example.com/.well-known.json"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.setWhitelistCallbackUrls

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.setWhitelistCallbackUrls`

Set organization whitelistCallbackUrls

#### Request Body

| Name                  | Type   | Description                          |
| --------------------- | ------ | ------------------------------------ |
| organizationId        | string | Organization id                      |
| whitelistCallbackUrls | array  | An array with callback whitelist URL |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "whitelistCallbackUrls": "[\"infomaker.io\", \"infomaker-test.io\"]"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /organizations.unblock

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/organizations.unblock`

Unblock organization by id

#### Request Body

| Name           | Type   | Description     |
| -------------- | ------ | --------------- |
| organizationId | string | Organization id |

{% tabs %}
{% tab title="204 No Content" %}

```javascript
""
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}