User

For the moment, user is a way to create an account and then get a write access to a project you created.

User Specification

kind: "User"
metadata:
  # User name for login
  name: <string>
spec:
  [ firstName: <string> ]
  [ lastName: <string> ]

  # Password when provided is hashed and salted before going to the database
  # Password is optional because depending on the Perses configuration, you might be able to login with external
  # authentication provider or not be able to create a user at all.
  # It can happen when the Perses server relies on a ldap database for authentication.
  [ nativeProvider: [ password: <string>]] 

  # Save the context of the oauth provider used if the user has been created from an external OIDC or OAuth
  # authentication provider.
  oauthProviders:  
  - [ <OAuth Provider specification> ]

OAuth Provider specification

# Identifying the provider
issuer: <string>

# Email of the user in the provider
email: <string>

# Identifying the user in the provider
subject: <string>

API definition

Get a list of User

GET /api/v1/users

URL query parameters:

  • name = <string> : filters the list of users based on their login name (prefix).

Get a single User

GET /api/v1/users/<name>

Create a single User

POST /api/v1/users

Update a single User

PUT /api/v1/users/<name>

Delete a single User

DELETE /api/v1/users/<name>