CEceph
SMB

Get smb join authorization resource

    Get Join auth resource

    :return: Returns join auth.
    :rtype: Dict
get/api/smb/joinauth/{auth_id}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/smb/joinauth/{auth_id}
  • Auth
    HTTP bearer

Path parameters

auth_idstring required

Response

OK

auth_idstring required

Unique identifier for the join auth resource

intentstring required

Desired state of the resource, e.g., 'present' or 'removed'

linked_to_clusterstring 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_typestring required

ceph.smb.join.auth

Changes

No recorded changes to this operation across all 68 revisions of this API.