# Logon Organization

Initiates a new session for the given member in specified Synqly organization.

Operation ID: auth_logon

Endpoint: POST /v1/auth/logon/{organizationId}
Security: BearerAuth

## Path parameters:

  - `organizationId` (string, required)

## Request fields (application/json):

  - `name` (string, required)
    Email address identifying the member to initiate a session for.

  - `secret` (string, required)
    Password of the member to initiate a session for.

## Response 200 fields (application/json):

  - `result` (object, required)

  - `result.auth_code` (string, required)
    Enum: "success", "failure", "disabled", "expired", "invited", "locked"

  - `result.refresh_token_id` (string, required)

  - `result.token` (object, required)

  - `result.token.access` (object, required)

  - `result.token.access.secret` (string, required)
    Secret value for the token; used for authentication when making requests.

  - `result.token.access.expires` (string, required)
    Time when this token expires and can no longer be used again.

  - `result.token.access.permissions` (object, required)

  - `result.token.access.permissions.resource_id` (string, required)

  - `result.token.access.permissions.resource_type` (string, required)
    Type of the resource that this permission grants access to. Must be one of the following: "organization, "integration"

  - `result.token.access.permissions.parent_id` (string, required)

  - `result.token.access.permissions.id` (string, required)

  - `result.token.access.permissions.organization_id` (string, required)

  - `result.token.access.permissions.member_id` (string, required)

  - `result.token.access.permissions.role_binding` (array,null)
    Roles granted to this token.

  - `result.token.access.permissions.adhoc_role` (object)

  - `result.token.access.permissions.adhoc_role.resources` (object, required)

  - `result.token.access.permissions.adhoc_role.resources.organizations` (object)

  - `result.token.access.permissions.adhoc_role.resources.organizations.ids` (array, required)
    List of organization ids that this role definition grants access to. Use "*" to grant access to all organization ids.

  - `result.token.access.permissions.adhoc_role.resources.organizations.labels` (array,null)
    List of organization labels this role definition grants access to.

  - `result.token.access.permissions.adhoc_role.resources.accounts` (object)

  - `result.token.access.permissions.adhoc_role.resources.accounts.ids` (array, required)
    List of account ids that this role definition grants access to. Use "*" to grant access to all account ids.

  - `result.token.access.permissions.adhoc_role.resources.accounts.labels` (array,null)
    List of account labels this role definition grants access to. If both labels and environments are specified both must pass

  - `result.token.access.permissions.adhoc_role.resources.accounts.environments` (array,null)
    Account environments this role definition grants access to. If both labels and environments are specified both must pass
    Enum: "test", "prod"

  - `result.token.access.permissions.adhoc_role.resources.integrations` (object)

  - `result.token.access.permissions.adhoc_role.resources.integrations.categories` (array, required)
    List of categories ids that this role definition grants access to. Use "*" to grant access to all category ids.
    Enum: "appsec", "assets", "chat", "cloudsecurity", "custom", "edr", "emailsecurity", "endpointmanagement", "identity", "incidentresponse", "networksecurity", "notifications", "siem", "sink", "storage", "ticketing", "vulnerabilities"

  - `result.token.access.permissions.adhoc_role.permission_set` (string, required)
    Enum: "administrator", "viewer", "member", "account-manager", "connect-ui", "token-issuer", "mcp-integrations-use-only", "mcp-management"

  - `result.token.access.permissions.root_organization_id` (string)

  - `result.token.access.claims` (object,null)
    Additional claims added to the token.

  - `result.token.refresh` (object, required)

  - `result.organization` (object, required)

  - `result.organization.id` (string, required)

  - `result.organization.refresh_token_id` (string, required)

  - `result.organization.organization_type` (string, required)
    Enum: "root", "standard"

  - `result.organization.fullname` (string, required)
    Human friendly display name for this Organization

  - `result.organization.name` (string, required)
    Human-readable name for this resource

  - `result.organization.created_at` (string, required)
    Time object was originally created

  - `result.organization.updated_at` (string, required)
    Last time object was updated

  - `result.organization.contact` (string,null)
    Organization email address

  - `result.organization.reply_to` (string,null)
    Reply-to email address, used for SMTP emails. Defaults to no-reply@synqly.com

  - `result.organization.picture` (string,null)
    Picture URL of the organization

  - `result.organization.options` (object)

  - `result.organization.options.invite_duration` (string,null)
    Duration new member invitations will be valid. Default: 168h (7 days), minimum 24h, maximum 168h (7 days).

  - `result.organization.options.forgot_duration` (string,null)
    Duration forgotten password invitations will be valid. Default: 24h, minimum 24h, maximum 168h (7 days).

  - `result.organization.options.password_duration` (string,null)
    Duration before member password expires, part of required password rotation. Default: 4320h (180 days), minimum: 24h, maximum: 8760h (365 days).

  - `result.organization.options.minimum_password_length` (integer,null)
    Minimum password length. Default: 8, minimum 8, maximum 72.

  - `result.organization.state` (string)
    Organization state. When disabled, all management and engine API requests for the organization return HTTP 402. An organization with no state set is enabled. pov (sales-run proof-of-value evaluation) and plg (self-signup) carry an end_date; a plg organization behaves like disabled after its end_date passes (end-of-day UTC), while pov never blocks automatically.
    Enum: "enabled", "disabled", "pov", "plg"

  - `result.organization.end_date` (string,null)
    Evaluation end date (YYYY-MM-DD, end-of-day UTC) for pov/plg organizations. Omitted otherwise. Set together with state through the private organizations API.

  - `result.member` (object, required)

  - `result.member.id` (string, required)

  - `result.member.state` (string, required)
    Enum: "disabled", "enabled", "forgotten", "invited", "locked"

  - `result.member.last_logon` (string, required)
    Last logon time

  - `result.member.fullname` (string, required)
    User's full display name.

  - `result.member.ttl` (string, required)

  - `result.member.token_ttl` (string, required)

  - `result.member.expires` (string, required)

  - `result.member.pin_expires` (string, required)

  - `result.member.role_binding` (array, required)
    Roles granted to this member. Tokens inherit this access.

  - `result.member.type` (string, required)
    Enum: "personal", "service"

  - `result.member.name` (string, required)
    Human-readable name for this resource

  - `result.member.created_at` (string, required)
    Time object was originally created

  - `result.member.updated_at` (string, required)
    Last time object was updated

  - `result.member.nickname` (string,null)
    User's nickname

  - `result.member.picture` (string,null)
    Url of user's picture

  - `result.auth_msg` (string,null)
    Authentication failure message

## Response 400 fields (application/json):

  - `occurred_at` (string, required)
    The date and time the problem occurred.

  - `status` (integer, required)
    The HTTP status code of the problem. Matches the HTTP response code sent by the server.

  - `instance` (string, required)
    A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  - `message` (string, required)
    A short, display-friendly summary of the problem.

  - `type` (string)
    A URI reference that identifies the type of problem that occurred. When the URI scheme is HTTP(s), it may or may not be possible to deference the URL to a display-friendly description of the problem type.

  - `cause` (array,null)
    A list of the root cause(s) for this problem occurrence. Includes at minimum one root cause, and is otherwise an unordered list of causes.

  - `cause.type` (string, required)
    A URI reference that identifies the type of problem that occurred. When the URI scheme is HTTP(s), it may or may not be possible to deference the URL to a display-friendly description of the problem type.

  - `cause.message` (string, required)
    A short, display-friendly summary of the problem.

  - `cause.detail` (string,null)
    A display-friendly and more detailed explanation of the problem. It may offer additional contextual detail, but may also be just a generic description of the problem.

  - `cause.remediation` (string,null)
    A display-friendly explanation for how to remediate the problem. This field may be omitted in case there are multiple problems, each with its own remediation, or if no remediation is possible.

  - `cause.context` (object)

  - `cause.context.parameter` (object)

  - `cause.context.parameter.id` (string, required)
    If the location of the parameter is body, this value is always a JSON Pointer, otherwise it's the name of the parameter.

  - `cause.context.parameter.location` (string, required)
    Enum: "header", "path", "query", "body"

  - `cause.context.parameter.value` (any,null)
    The given value of the parameter.

  - `cause.context.resources` (array,null)

  - `cause.context.resources.type` (string, required)
    Enum: "account", "bridge", "credential", "integration_point", "integration", "member", "operation", "organization_webhook", "role", "sub_org", "token", "transform"

  - `cause.context.resources.id` (string, required)
    ID of the related resource.

  - `cause.context.resources.rel` (string, required)
    Enum: "affected", "cause"

  - `cause.context.raw_error` (string,null)
    If available this represents the underlying raw error, for example an error response from a Provider.

  - `cause.context.provider_details` (object,null)
    If available this represents the underlying details from the provider. May include the error message, status code, and other details.

  - `detail` (string,null)
    A display-friendly and more detailed explanation of the problem. It may offer additional contextual detail, but may also be just a generic description of the problem.

  - `remediation` (string,null)
    A display-friendly explanation for how to remediate the problem. This field may be omitted in case there are multiple problems, each with its own remediation, or if no remediation is possible.

  - `context` (object)