Read organisation admin

GET 
/v2/onboard/organisation/admin/:adminId

Reads one admin of the organisation.

Request

Path Parameters

adminId stringrequired

Unique ID of an Admin

Responses

200

The admin.

application/json

Schema

Schema

admin object

id stringrequired

Unique identifier for the admin

email emailrequired

Admin's email address

name stringrequired

Full name of the admin

phone stringrequired

Admin's phone number

imageId string

Unique identifier for the admin's image

imageUrl string

URL to the admin's image

externalId string

External identifier for the admin

identityProviderId string

Identity provider ID

roleId integerrequired

Numeric ID of the assigned role

roleName stringrequired

Human-readable name of the role

authentication objectrequired

Configuration for authentication methods

password object

Configuration for password authentication

enabled boolean

oidcPasswordless object

Configuration for Passwordless Login with EUDI Wallet

enabled boolean

Whether Passwordless Login is enabled for the user

linked boolean

Whether the user has linked their EUDI Wallet for Passwordless Login

authenticatorCredentialExchangeId string

Credential Exchange ID of the issued iGrant.io Authenticator credential

pendingInvitation booleanrequired

Indicates if the admin account has a pending invitation

organizationId string

Unique identifier for the organization

organizationName string

Name of the organization

Example (from schema)

{
  "admin": {
    "id": "string",
    "email": "[email protected]",
    "name": "string",
    "phone": "string",
    "imageId": "string",
    "imageUrl": "string",
    "externalId": "string",
    "identityProviderId": "string",
    "roleId": 0,
    "roleName": "string",
    "authentication": {
      "password": {
        "enabled": true
      },
      "oidcPasswordless": {
        "enabled": true,
        "linked": true,
        "authenticatorCredentialExchangeId": "string"
      }
    },
    "pendingInvitation": true,
    "organizationId": "string",
    "organizationName": "string"
  }
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

Resource not found

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...