---
title: "Create smb join auth"
method: POST
path: "/api/smb/joinauth"
tags: ["SMB"]
---

# Create smb join auth

`POST /api/smb/joinauth`

Create smb join auth resource

        :return: Returns join auth resource.
        :rtype: Dict

## Request body

- object
  - `join_auth` string, required

## Response `201`

Resource created.

- object
  - `results` object[], required — List of operation results
    - `resource` object, required — Resource
      - `auth` object, required — Authentication credentials
        - `password` string, required — Password for authentication
        - `username` string, required — Username for authentication
      - `auth_id` string, required — Unique identifier for the join auth resource
      - `intent` string, required — Desired state of the resource, e.g., 'present' or 'removed'
      - `linked_to_cluster` string, required — Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed
      - `resource_type` string, required — ceph.smb.join.auth
    - `state` string, required — The current state of the resource, e.g., 'created', 'updated', 'deleted'
    - `success` boolean, required — Indicates if the operation was successful
  - `success` boolean, required — Indicates if the overall operation was successful

## Other responses

- `202` — Operation is still executing. Please check the task queue.
- `400` — Operation exception. Please check the response body for details.
- `401` — Unauthenticated access. Please login first.
- `403` — Unauthorized access. Please check your permissions.
- `500` — Unexpected error. Please check the response body for the stack trace.

---

[API](https://skmtc.net/ceph/apis/ceph-rest-api.md) · [All operations](https://skmtc.net/ceph/apis/ceph-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ceph/ceph-rest-api/versions/b03ae23c3806/schema)