v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Nodes
Identifiers

Mint a New Identifier for a Node

Mint (create) a new identifier for the specified node. Currently, the OSF supports minting DOI identifiers through this endpoint. Once created, identifiers are permanent and cannot be modified or deleted.

Supported Identifier Categories

  • doi: Digital Object Identifier.

Requirements

  • You must have Admin or Write permissions on the node.
  • The node must be public and must not be a collection or folder.
  • Only nodes representing individual projects or components are eligible for DOI creation.

Example Request Payload

{
  "data": {
    "type": "identifiers",
    "attributes": {
      "category": "doi"
    }
  }
}

Permissions

  • Only authenticated users with the required permissions can mint new identifiers.
  • This endpoint is does not authenticate for nodes that are private or not publicly available.
post/nodes/{node_id}/identifiers/

Path parameters

node_idstring required

The unique identifier of the node for which you want to create an identifier.

Response

Identifier successfully created.