Administration
Beta Preview
The facade clients are in beta in istari-digital-client 14.0.0, and their API may change between releases. Facade clients (beta) explains how they work.
Manage users, tokens, keys, infosec levels, tenants and usage. These managers are on IstariAdmin.
The same domain on the other clients: Client: Administration, Keys and Infosec levels. V3Client: batch_resolve_users().
admin.users
| Method | What it does |
|---|---|
admin.users.list | List users (a plain list) |
admin.users.get | Fetch one user |
admin.users.current | The signed-in user |
admin.tokens
| Method | What it does |
|---|---|
admin.tokens.list | Your personal access tokens |
admin.tokens.create | Create a personal access token (deprecated; use a Key) |
admin.tokens.create_agent_token | Create a personal access token for an agent |
admin.tokens.delete | Revoke a personal access token |
admin.keys
| Method | What it does |
|---|---|
admin.keys.generate_keypair | Generate a key pair locally, without registering it |
admin.keys.list | A principal's keys (deprecated; use admin.identity.keys) |
admin.keys.get | One key's metadata (deprecated) |
admin.keys.register | Register a key's public half (deprecated) |
admin.keys.generate_and_register | Generate and register a key in one step (deprecated) |
admin.keys.revoke | Revoke a key (deprecated) |
admin.identity.tenants
| Method | What it does |
|---|---|
admin.identity.tenants.list | Tenants you can see (a plain list) |
admin.identity.tenants.get | Fetch one tenant |
admin.identity.tenants.create | Create a tenant |
admin.identity.tenants.update | Change a tenant's fields |
admin.identity.tenants.activate | Return a deactivated tenant to service |
admin.identity.tenants.deactivate | Deactivate a tenant and suspend its members |
admin.identity.tenants.set_default | Make a tenant the installation default |
admin.identity.memberships
| Method | What it does |
|---|---|
admin.identity.memberships.list | A tenant's members |
admin.identity.memberships.list_humans | A tenant's human members |
admin.identity.memberships.list_agents | A tenant's agent members |
admin.identity.memberships.list_for_principal | One principal's memberships |
admin.identity.memberships.grant | Add a member by principal id or email |
admin.identity.memberships.revoke | End a membership |
admin.identity.principals
| Method | What it does |
|---|---|
admin.identity.principals.list | Principals of every kind |
admin.identity.principals.get | Fetch one principal |
admin.identity.principals.me | The authenticated principal |
admin.identity.principals.resolve | Resolve many principal ids in one call |
admin.identity.principals.activate | Return a deactivated principal to service |
admin.identity.principals.deactivate | Deactivate a principal |
admin.identity.principals.humans
| Method | What it does |
|---|---|
admin.identity.principals.humans.list | List people |
admin.identity.principals.humans.get | Fetch one person |
admin.identity.principals.humans.create | Create a person |
admin.identity.principals.humans.update | Change a person's fields |
admin.identity.principals.humans.deactivate | Deactivate a person |
admin.identity.principals.agents
| Method | What it does |
|---|---|
admin.identity.principals.agents.list | List agent principals |
admin.identity.principals.agents.get | Fetch one agent principal |
admin.identity.principals.agents.create | Create an agent principal |
admin.identity.principals.agents.update | Change an agent principal's fields |
admin.identity.principals.agents.deactivate | Deactivate an agent principal |
admin.identity.keys
| Method | What it does |
|---|---|
admin.identity.keys.list | A principal's keys ("me" for the caller) |
admin.identity.keys.get | One key's metadata |
admin.identity.keys.register | Register a key pair's public key |
admin.identity.keys.generate_and_register | Generate a key pair and register it in one step |
admin.identity.keys.revoke | Revoke a key |
admin.identity.roles
| Method | What it does |
|---|---|
admin.identity.roles.list | The role catalog |
admin.identity.roles.holders | Principals that hold a role |
admin.identity.roles.list_principal_roles | One principal's role grants |
admin.identity.roles.list_tenant_roles | Role grants within a tenant |
admin.identity.roles.grant_principal_role | Grant a role, platform-wide or in one tenant |
admin.identity.roles.grant_tenant_role | Grant a tenant-scoped role |
admin.identity.roles.revoke_principal_role | Revoke a principal's role |
admin.identity.roles.revoke_tenant_role | Revoke a tenant-scoped role |
admin.identity.oauth
| Method | What it does |
|---|---|
admin.identity.oauth.issue_token | Exchange a client assertion, code or refresh token for a token |
admin.identity.oauth.introspect | Introspect a token |
admin.infosec
| Method | What it does |
|---|---|
admin.infosec.list_levels | Available classification levels |
admin.infosec.assign | Set a classification level on a model, artifact, System or user |
admin.tenants
| Method | What it does |
|---|---|
admin.tenants.list | List tenants, one page at a time |
admin.tenants.get_public_key | The current tenant's public key |
admin.tenants.create_public_key | Register a public key for the current tenant |
admin.tenants.update_public_key | Replace the current tenant's public key |
admin.tenants.delete_public_key | Delete the current tenant's public key |
admin.usage
| Method | What it does |
|---|---|
admin.usage.metrics | Storage and consumption metrics for a date range |
admin.identity needs a Key and the identity service's v2 API. Identity administration documents its methods, the roles each needs, and which admin.keys methods it replaces.