identity-platform-admin-ui

README

Identity Platform Admin UI

This is the Admin UI for the Canonical Identity Platform.

Environment Variables

• OTEL_GRPC_ENDPOINT: address of the open telemetry grpc endpoint, used for tracing
• OTEL_HTTP_ENDPOINT: address of the open telemetry http endpoint, used for tracing (grpc endpoint takes precedence)
• TRACING_ENABLED: flag enabling tracing
• LOG_LEVEL: log level, one of info,warn,error,debug, defaults to error
• LOG_FILE: file where to dump logs, defaults to log.txt
• PORT : http server port, defaults to 8080
• DEBUG: debugging flag for hydra and kratos clients
• KRATOS_PUBLIC_URL: Kratos public endpoints address
• KRATOS_ADMIN_URL: Kratos admin endpoints address
• HYDRA_ADMIN_URL: Hydra admin endpoints address
• IDP_CONFIGMAP_NAME: name of the k8s config map containing Identity Providers
• IDP_CONFIGMAP_NAMESPACE: namespace of the k8s config map containing Identity Providers
• SCHEMAS_CONFIGMAP_NAME: name of the k8s config map containing Identity Schemas
• SCHEMAS_CONFIGMAP_NAMESPACE: namespace of the k8s config map containing Identity Schemas

Development setup

As a requirement, please make sure to:

• have rockcraft, yq, skopeo and make installed

  snap install rockcraft
  snap install yq
  apt install skopeo
  apt install make
  

• microk8s is installed with the registry addon operating at localhost:32000 and kubectl configured to use it

  snap install microk8s --classic
  microk8s status --wait-ready
  microk8s enable registry
  # ensure kubectl is configured to use microk8s
  microk8s.kubectl config view --raw > $HOME/.kube/config
  

• ensure skaffold, container-structure-test and docker are installed according to their documentation

Run make dev to get a working environment in k8s

Endpoint examples

> http :8000/api/v0/identities
HTTP/1.1 200 OK
Content-Length: 86
Content-Type: application/json
Date: Wed, 11 Oct 2023 10:05:37 GMT
Vary: Origin

{
    "_meta": {
        "page": 1,
        "size": 100
    },
    "data": [],
    "message": "List of identities",
    "status": 200
}

> http :8000/api/v0/idps      
HTTP/1.1 200 OK
Content-Length: 1520
Content-Type: application/json
Date: Wed, 11 Oct 2023 10:05:43 GMT
Vary: Origin

{
    "_meta": null,
    "data": [
        {
            "apple_private_key": "",
            "apple_private_key_id": "",
            "apple_team_id": "",
            "auth_url": "",
            "client_id": "af675f35-3bd7-4515-88e2-b8032e315f6f",
            "client_secret": "3y38Q~aslkdhaskjhd~W0xWDB.123u98asd",
            "id": "microsoft_af675f353bd7451588e2b8032e315f6f",
            "issuer_url": "",
            "label": "",
            "mapper_url": "file:///etc/config/kratos/microsoft_schema.jsonnet",
            "microsoft_tenant": "e1574293-28de-4e94-87d5-b61c76fc14e1",
            "provider": "microsoft",
            "requested_claims": null,
            "scope": [
                "profile",
                "email",
                "address",
                "phone"
            ],
            "subject_source": "",
            "token_url": ""
        },
        {
            "apple_private_key": "",
            "apple_private_key_id": "",
            "apple_team_id": "",
            "auth_url": "",
            "client_id": "18fa2999-e6c9-475a-a495-15d933d8e8ce",
            "client_secret": "3y38Q~aslkdhaskjhd~W0xWDB.123u98asd",
            "id": "google_18fa2999e6c9475aa49515d933d8e8ce",
            "issuer_url": "",
            "label": "",
            "mapper_url": "file:///etc/config/kratos/google_schema.jsonnet",
            "microsoft_tenant": "",
            "provider": "google",
            "requested_claims": null,
            "scope": [
                "profile",
                "email",
                "address",
                "phone"
            ],
            "subject_source": "",
            "token_url": ""
        },
        {
            "apple_private_key": "",
            "apple_private_key_id": "",
            "apple_team_id": "",
            "auth_url": "",
            "client_id": "18fa2999-e6c9-475a-a495-89d941d8e1zy",
            "client_secret": "3y38Q~aslkdhaskjhd~W0xWDB.123u98asd",
            "id": "aws_18fa2999e6c9475aa49589d941d8e1zy",
            "issuer_url": "",
            "label": "",
            "mapper_url": "file:///etc/config/kratos/google_schema.jsonnet",
            "microsoft_tenant": "",
            "provider": "aws",
            "requested_claims": null,
            "scope": [
                "profile",
                "email",
                "address",
                "phone"
            ],
            "subject_source": "",
            "token_url": ""
        }
    ],
    "message": "List of IDPs",
    "status": 200
}

> http :8000/api/v0/clients     
HTTP/1.1 200 OK
Content-Length: 316
Content-Type: application/json
Date: Wed, 11 Oct 2023 10:05:47 GMT
Vary: Origin

{
    "_links": {
        "first": "/api/v0/clients?page=eyJvZmZzZXQiOiIwIiwidiI6Mn0&size=200",
        "next": "/api/v0/clients?page=eyJvZmZzZXQiOiIyMDAiLCJ2IjoyfQ&size=200",
        "prev": "/api/v0/clients?page=eyJvZmZzZXQiOiItMjAwIiwidiI6Mn0&size=200"
    },
    "_meta": {
        "total_count": "0"
    },
    "data": [],
    "message": "List of clients",
    "status": 200
}