Directory

iya-sts is a user and an application. Both are protocol-independent. A user is one person, whichever protocol authenticated them. An application is one application, whichever protocol it spoke. OAuth, OpenID Connect, SAML, WS-Trust, WS-Federation, Kerberos, GNAP and the others name that pair. A token, an assertion and a ticket say those two objects in the protocol that asked.

The session is the record of one sign-in. It belongs to the user. The application is the other party. A credential the service accepts is evidence about the user.

The directory is where a realm keeps them. Each trust realm has a tree of its own. LDAP lists every container. The object is an entry, and the service reads that entry the next time it needs it. A policy is what the user and the application are held to.

Object Where it lives Page
User ou=users People
Application ou=applications Applications
Policy the kind’s own container Policies

A group is an entry under ou=groups. It can name a policy for its members. What a group grants by being named in a roster or a role is on that page.

The relationship is one way. The user and the application are the holders. A group is a third holder. The profile lists nobody. Who names which kind and how one is chosen.

A person

People defines the entry: the subject, the filing name, and a sign-in name. A service account is that entry with a flag.

As a holder, a person names an attribute policy, and a service account names a service-account policy. The person’s groups name the other kinds. The application they are signing in to names its own.

Configuring a person

These doors write the same entry.

What you are doing Where
Create the person, and set the username Directory → Users, Creating a person. POST /admin-api/users/create. Put a person in the directory and bind as them. SCIM. Bulk import
Attributes the realm requires, and custom attributes The attribute policy
The attributes on the entry Changing a person’s attributes. The catalogue is LDAP schema
A sign-in name Adding and removing one
Password, lock, second factors Password and second factors. The rules are the password policy
What the person may change /portal and the Account API
Make the entry a service account Service accounts
One entry per username One entry per person

An application

Applications defines the entry: the identifier, the filing name, and the name each protocol calls it. A resource server is that entry used as an audience. One application, one entry.

As a holder, an application names a password, authentication, passkey, locale or post-login policy for a sign-in to it. The profile it names is a candidate while this application is the one in hand. Who names which kind.

Configuring an application

These doors write the same entry.

What you are doing Where
Create the application, and set the identifier Directory → Applications, New application. POST /admin-api/applications/create. RFC 7591. An LDAP add under ou=applications. In development, the first acceptance of the identifier. One application, one entry
The identifier, the filing name, and a protocol name The names
What each protocol calls it, and where a browser is sent back New application. One entry per identifier
Which families it is declared for Declared families and recorded ones
The secret, and whether the client is public The client secret. What the checks read
Grants, scopes, consent, a delegated permission The console page and the API. Delegated permissions
Which origins may read an answer CORS
How its people may sign in, and which second factors Sign-in mechanisms. Second factors
Name a policy for a sign-in to it Named policies. Who names which kind
A software statement Software statements
Move one between deployments Exporting and importing an application as LDIF
Withdraw the registration, or remove the entry Registration and a sighting
Change what a protocol checks OAuth grants, OpenID Connect flows, SAML, WS-Trust, WS-Federation, Kerberos, GNAP

A policy

Policies is the seven profiles, which holder names which kind, and how the lowest precedence is chosen. An XACML policy in ou=policies is a different object. Authorization.

Configuring a policy

What you are doing Where
Edit default, add a named profile, see who names it Directory → Policies. Writing and deleting
Save or remove one from the API The operations Writing and deleting names. The live list is GET /admin-api/openapi.json
Decide which holder names which kind Who names which kind
Change what a profile’s fields do The kind’s own page, from The seven kinds
Read the password policy as an entry The password policy is a directory entry

Reaching the directory