Get a specific bearer token - Cisco Nexus Hyperfabric API

{"type":"api","title":"Get a specific bearer token","meta":{"id":"/apps/pubhub/media/tortuga-api-documentation/10148f2b488c23df1b3fce5b90477e27e36b9645/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"contact":{"email":"hyperfabric-support@cisco.com","name":"Cisco Nexus Hyperfabric REST API","url":"https://hyperfabric.cisco.com"},"description":"Use this documentation to explore the API in detail.\n\nEach request will have a complete description of all the accepted parameters.\n\n## Authentication\n\nRequests are authenticated using Bearer Tokens. Tokens should be created from within the Hyperfabric service web UI and stored securely.\n\nSee the [bearer token](https://developer.cisco.com/docs/hyperfabric/authentication/#bearer-tokens) documentation page for more details.\n","license":{"name":"Cisco Licensing","url":"https://www.cisco.com/c/dam/en_us/about/doing_business/legal/Cisco_General_Terms.pdf"},"termsOfService":"https://www.cisco.com/c/dam/en_us/about/doing_business/legal/Cisco_General_Terms.pdf","title":"Cisco Nexus Hyperfabric REST API","version":"1.0.6-Rev.2025-03-11.13103"},"security":[{"http":[]}],"tags":[{"description":"APIs for managing authorization, account, users, API keys and tokens.","name":"Auth"},{"description":"APIs for managing devices.","name":"Devices"},{"description":"APIs for managing fabrics, candidate configurations and fabric connections.","name":"Fabrics"},{"description":"APIs for managing nodes, ports, port channels and other interfaces.","name":"Nodes"},{"description":"APIs for managing VNIs","name":"Vnis"},{"description":"APIs for managing VRFs.","name":"Vrfs"}],"openapi":"3.0.3","servers":[{"description":"V1 Server","url":"https://hyperfabric.cisco.com/api/v1"}],"securitySchemes":{"http":{"bearerFormat":"JWT","description":"A bearer token issued by the service","scheme":"bearer","type":"http"}}},"spec":{"description":"Get a specific bearer token associated with the user.","operationId":"authGetBearerToken","parameters":[{"description":"The token id.","in":"path","name":"tokenId","required":true,"schema":{"type":"string"}},{"description":"Include metadata in the response.","in":"query","name":"includeMetadata","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"description":"An example response to an API call.","summary":"Example response","value":{"name":"example-token","description":"An example bearer token used for demonstration","scope":"TOKEN_SCOPE_ADMIN","notBefore":"2024-09-07T00:26:24.701821Z","notAfter":"2025-09-07T00:26:24.701821Z","tokenId":"cadf5a4b-9e8d-4339-ba44-5e6d4d9f572c"},"$$ref":"#/components/examples/authGetBearerTokenResponse"}},"schema":{"description":"A Bearer Token is a JSON Web Token (JWT) used for authentication and authorization against the Cisco Nexus Hyperfabric REST API. The JWT is a compact, URL-safe means of representing a JSON object containing a set of key-value pairs as described in RFC 7159. It is passed as Bearer token in the Authentication header of every HTTP API request.","properties":{"description":{"description":"The description is a user-defined field to store notes about the bearer token.","type":"string"},"metadata":{"description":"Metadata defines a map of attributes related to the lifecycle of the object.","properties":{"createdAt":{"description":"This is a read-only field. The timestamp when this object was created in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (e.g. `YYYY-MM-DDTHH:MM:SSZ`).","format":"date-time","readOnly":true,"type":"string"},"createdBy":{"description":"This is a read-only field. The identity provider and email of the user that created this object.","readOnly":true,"type":"string"},"modifiedAt":{"description":"This is a read-only field. The timestamp when this object was last modified in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (e.g. `YYYY-MM-DDTHH:MM:SSZ`).","format":"date-time","readOnly":true,"type":"string"},"modifiedBy":{"description":"This is a read-only field. The identity provider and email of the user that modified this object last.","readOnly":true,"type":"string"},"revisionId":{"description":"This is a read-only field. An integer that represent the current revision of the object.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/modelsMetadata"},"name":{"description":"The user-defined name of the bearer token.","type":"string"},"notAfter":{"description":"The end date and time for the validity of the bearer token in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (e.g. `YYYY-MM-DDTHH:MM:SSZ`).","format":"date-time","type":"string"},"notBefore":{"description":"The start date and time for the validity of the bearer token in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (e.g. `YYYY-MM-DDTHH:MM:SSZ`).","format":"date-time","type":"string"},"scope":{"default":"TOKEN_SCOPE_ADMIN","description":"TokenScope defines an enumeration of scopes that represents different level of privileges that can be associated with bearer tokens and API keys.","enum":["TOKEN_SCOPE_ADMIN","TOKEN_SCOPE_READ_ONLY","TOKEN_SCOPE_READ_WRITE"],"type":"string","$$ref":"#/components/schemas/modelsTokenScope"},"token":{"description":"This is a read-only field. The JWT token that represent the bearer token. The token is only available at the bearer token creation.","readOnly":true,"type":"string"},"tokenId":{"description":"This is a read-only field. The unique identifier of the bearer token.","readOnly":true,"type":"string"}},"type":"object","$$ref":"#/components/schemas/authBearerToken"}}},"description":"OK","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}}},"400":{"content":{"application/json":{"examples":{"400":{"description":"Bad Request","summary":"Bad Request","value":{"message":"cannot parse value: not a valid value","field":"value","value":"123","status":400,"errCode":"ERR_CODE_INVALID_VALUE","trackingId":"TrackingId-a5767554-f150-47f5-8e94-425e802b25c9"},"$$ref":"#/components/examples/400"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Bad Request","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}}},"401":{"content":{"application/json":{"examples":{"401":{"description":"Unauthorized","summary":"Unauthorized","value":{"message":"authorization failure","status":401,"errCode":"ERR_CODE_UNAUTHORIZED","trackingId":"TrackingId-32dee1eb-6447-4275-a441-b9a9bcd90bb7"},"$$ref":"#/components/examples/401"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Unauthorized","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}}},"403":{"content":{"application/json":{"examples":{"403":{"description":"Forbidden","summary":"Forbidden","value":{"message":"insufficient privileges to access resource","status":403,"errCode":"ERR_CODE_PERMISSION_DENIED","trackingId":"TrackingId-c4b86cca-2d39-4269-9f94-1a0b7ff3dbb3"},"$$ref":"#/components/examples/403"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Forbidden","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}}},"429":{"content":{"application/json":{"examples":{"429":{"description":"Too Many Requests","summary":"Too Many Requests","value":{"message":"too many requests","status":429,"errCode":"ERR_CODE_TOO_MANY_REQUESTS","trackingId":"TrackingId-2605e772-2369-4f94-bcee-a1386e05fd74"},"$$ref":"#/components/examples/429"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Too Many Requests","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}}},"500":{"content":{"application/json":{"examples":{"500":{"description":"Internal Server Error","summary":"Internal Server Error","value":{"message":"an internal error has occurred","status":500,"errCode":"ERR_CODE_INTERNAL","trackingId":"TrackingId-a619a6f4-36a5-4296-a636-7dd98f5c5657"},"$$ref":"#/components/examples/500"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Internal Server Error","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}}}},"security":[{"http":[]}],"summary":"Get a specific bearer token.","tags":["Auth"],"__originalOperationId":"authGetBearerToken","method":"get","path":"/bearerTokens/{tokenId}"}}