Create a new session
Create a new session. A token will be returned, which is required for further updates of the session.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- checks object- "Check for user and password. Successful checks will be stated as factors on the session." - user object- "checks the user and updates the session on success" userId string- Possible values: - non-emptyand- <= 200 charactersloginName string- Possible values: - non-emptyand- <= 200 characters- password object- "Checks the password and updates the session on success. Requires that the user is already checked, either in the previous or the same request." password string- Possible values: - non-emptyand- <= 200 characters
- metadata object- "custom key value list to be stored on the session" - property name*string
Request Body required
- checks object- "Check for user and password. Successful checks will be stated as factors on the session." - user object- "checks the user and updates the session on success" userId string- Possible values: - non-emptyand- <= 200 charactersloginName string- Possible values: - non-emptyand- <= 200 characters- password object- "Checks the password and updates the session on success. Requires that the user is already checked, either in the previous or the same request." password string- Possible values: - non-emptyand- <= 200 characters
- metadata object- "custom key value list to be stored on the session" - property name*string
Request Body required
- checks object- "Check for user and password. Successful checks will be stated as factors on the session." - user object- "checks the user and updates the session on success" userId string- Possible values: - non-emptyand- <= 200 charactersloginName string- Possible values: - non-emptyand- <= 200 characters- password object- "Checks the password and updates the session on success. Requires that the user is already checked, either in the previous or the same request." password string- Possible values: - non-emptyand- <= 200 characters
- metadata object- "custom key value list to be stored on the session" - property name*string
- 200
- 403
- 404
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- details objectsequence uint64- on read: the sequence of the last event reduced by the projection - on manipulation: the timestamp of the event(s) added by the manipulation changeDate date-time- on read: the timestamp of the last event reduced by the projection - on manipulation: the timestamp of the event(s) added by the manipulation resourceOwner resource_owner is the organization or instance_id an object belongs to
- sessionId string"id of the session" 
- sessionToken string"token of the session, which is required for further updates of the session or the request other resources" 
{
  "details": {
    "sequence": "2",
    "changeDate": "2023-05-15",
    "resourceOwner": "69629023906488334"
  },
  "sessionId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
  "sessionToken": "string"
}
- Schema
- Example (from schema)
Schema
- details objectsequence uint64- on read: the sequence of the last event reduced by the projection - on manipulation: the timestamp of the event(s) added by the manipulation changeDate date-time- on read: the timestamp of the last event reduced by the projection - on manipulation: the timestamp of the event(s) added by the manipulation resourceOwner resource_owner is the organization or instance_id an object belongs to
- sessionId string"id of the session" 
- sessionToken string"token of the session, which is required for further updates of the session or the request other resources" 
{
  "details": {
    "sequence": "2",
    "changeDate": "2023-05-15",
    "resourceOwner": "69629023906488334"
  },
  "sessionId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
  "sessionToken": "string"
}
- Schema
- Example (from schema)
Schema
- details objectsequence uint64- on read: the sequence of the last event reduced by the projection - on manipulation: the timestamp of the event(s) added by the manipulation changeDate date-time- on read: the timestamp of the last event reduced by the projection - on manipulation: the timestamp of the event(s) added by the manipulation resourceOwner resource_owner is the organization or instance_id an object belongs to
- sessionId string"id of the session" 
- sessionToken string"token of the session, which is required for further updates of the session or the request other resources" 
{
  "details": {
    "sequence": "2",
    "changeDate": "2023-05-15",
    "resourceOwner": "69629023906488334"
  },
  "sessionId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
  "sessionToken": "string"
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}