Naviga ID
Docs HomeInfomakerNaviga
  • Introduction
  • Release notes
  • Architecture
    • Authorization schema
  • Integrations
    • Customer Integration
      • Microsoft Azure
      • Google G Suite
      • Custom Identity Provider
      • Moving to a New Identity Provider
    • Service Integration
      • IMSG and headers
  • Services
    • Admin API
      • Routes
        • Health
        • Organizations
        • Permissions
        • Roles
        • Units
        • Services
        • Subjects
        • Organization applications
        • Internal applications
    • IMSG
      • Routes
        • Imsg-service
      • Environment variables
  • Shared modules
    • Http Test Server
      • HttpTestServer
    • Service Authorization Lib
      • Authorize
      • Errors
      • ExpressMiddleware
      • TokenUtils
      • Hapi plugin
      • ServiceAuthorizationError
      • AccessDenied
      • Unauthorized
      • ConfigError
  • Client Credentials
    • Managing Applications
    • Internal Naviga ID Docs
  • Access Token
    • Fetching and using Access Tokens
    • Validate Access Tokens
  • Local development
    • Local HTTPS support
  • Post Mortem
    • Broken backwards compatibility in access token service for client credentials, 20th Dec 2021
Powered by GitBook
On this page
  • /units.get
  • /units.list
  • /units.create
  • /units.delete
  • /units.setDescription
  • /units.setDisplayName
  • /units.setName

Was this helpful?

Export as PDF
  1. Services
  2. Admin API
  3. Routes

Units

/units.get

GET https://admin-api.imid.infomaker.io/v1/units.get

Get unit by id

Query Parameters

Name
Type
Description

unitId

string

UUIDv4

{
  "id": "Unit id",
  "organizationId": "Organization id",
  "name": "barometern",
  "displayName": "Barometern OT",
  "description": "Description of speicific part xxx",
  "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
}
"errors.api.BadRequestError"
"errors.api.InternalServerError"

/units.list

GET https://admin-api.imid.infomaker.io/v1/units.list

List units

Query Parameters

Name
Type
Description

id

string

Unit id

name

string

Unit name

displayName

string

Unit display name

organizationId

string

Organization id

updatedBySub

string

Organization subject

[
  {
    "id": "Unit id",
    "organizationId": "Organization id",
    "name": "barometern",
    "displayName": "Barometern OT",
    "description": "Description of speicific part xxx",
    "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
  }
]
"errors.api.BadRequestError"
"errors.api.InternalServerError"

/units.create

POST https://admin-api.imid.infomaker.io/v1/units.create

Create unit

Request Body

Name
Type
Description

organizationId

string

Organization id

name

string

Unit name

displayName

string

Unit display name

description

string

Description of speicific part xxx

{
  "id": "Unit id",
  "organizationId": "Organization id",
  "name": "barometern",
  "displayName": "Barometern OT",
  "description": "Description of speicific part xxx",
  "updatedBySub": "infomaker_b8b9373b-a30d-459d-a44d-f270afb5e581"
}
"errors.api.BadRequestError"
"errors.api.InternalServerError"

/units.delete

POST https://admin-api.imid.infomaker.io/v1/units.delete

Delete unit by id

Request Body

Name
Type
Description

unitId

string

UUIDv4

""
"errors.api.BadRequestError"
"errors.api.InternalServerError"

/units.setDescription

POST https://admin-api.imid.infomaker.io/v1/units.setDescription

Set unit description by id

Request Body

Name
Type
Description

unitId

string

UUIDv4

description

string

Description of speicific part xxx

{
  "description": "Description of speicific part xxx"
}
"errors.api.BHadRequestError"
"errors.api.InternalServerError"

/units.setDisplayName

POST https://admin-api.imid.infomaker.io/v1/units.setDisplayName

Set unit display name by id

Request Body

Name
Type
Description

unitId

string

UUIDv4

displayName

string

Unit display name

{
  "displayName": "Barometern OT"
}
"errors.api.BadRequestError"
"errors.api.InternalServerError"

/units.setName

POST https://admin-api.imid.infomaker.io/v1/units.setName

Set unit name by id

Request Body

Name
Type
Description

unitId

string

UUIDv4

name

string

Unit name

{
  "name": "barometern"
}
"errors.api.BadRequestError"
"errors.api.InternalServerError"
PreviousRolesNextServices

Last updated 4 years ago

Was this helpful?