Introduction
This is the NetFoundry identity service
Overview
HTTP verbs
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP verbs.
Verb | Usage |
---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update an existing resource, full updates only |
|
Used to delete an existing resource |
The PATCH method is not used (yet).
|
HTTP status codes
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP status codes.
Status code | Usage |
---|---|
|
The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action. |
|
The request has been fulfilled and resulted in a new resource being created. |
|
The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services. |
|
The server successfully processed the request, but is not returning any content. |
|
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
|
The request lacks valid authentication credentials for the target resource. |
|
The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource. |
|
The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible. |
Resources
Organization
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization/find-organizations/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization/get-organization-by-id/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization/get-organization-by-label/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization/create-organization/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization/activate-or-deactivate-organization/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization/add-identity-provider/auto-section.adoc[]
Identity Providers
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-providers/find-identity-providers/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-providers/get-identity-provider/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-providers/create-identity-provider/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-providers/update-identity-provider/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-providers/activate-identity-provider/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-providers/delete-identity-provider/auto-section.adoc[]
Default Roles
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/default-roles/find-default-roles/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/default-roles/get-default-role/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/default-roles/create-default-role/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/default-roles/delete-default-role/auto-section.adoc[]
User Identity
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/get-self-identity/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/get-identity/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/find-user-identities/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/get-user-identity/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/get-user-identity-by-mapping/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/create-user-identity/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/update-user-identity-info/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/activate-or-deactivate-user-identity/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/reset-user-identity-mfa-settings/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/user-identity/map-identity/auto-section.adoc[]
API Account Identity
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/api-account-identity/find-api-account-identities/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/api-account-identity/get-api-account-identity/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/api-account-identity/get-api-account-identity-by-mapping/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/api-account-identity/create-api-account-identity/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/api-account-identity/update-api-account-identity-info/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/api-account-identity/activate-or-deactivate-api-account-identity/auto-section.adoc[]
Invitation
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/invitation/find-invitations/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/invitation/get-invitation-by-id/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/invitation/create-invitation/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/invitation/respond-to-invitation/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/invitation/revoke-invitation/auto-section.adoc[]
Support
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/support-request/create-support-request/auto-section.adoc[]
Invitation Flow
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/invitation-flow/get-invitation-by-key/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/invitation-flow/decline-invitation/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/invitation-flow/initiate-accept-invitation/auto-section.adoc[]
Login Flow
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/login-flow/initiate-interactive-authorization/auto-section.adoc[]
Identity Preference Flow
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-preferences/find-identity-preferences/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-preferences/get-identity-preference/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-preferences/create-identity-preference/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-preferences/update-identity-preference/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/identity-preferences/delete-identity-preference/auto-section.adoc[]
Organization Preference Flow
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization-preferences/find-organization-preferences/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization-preferences/get-organization-preference/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization-preferences/create-organization-preference/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization-preferences/update-organization-preference/auto-section.adoc[]
Unresolved directive in index.adoc - include::/home/jenkins/workspace/MOP_Services/identity/build_identity_api/target/generated-snippets/organization-preferences/delete-organization-preference/auto-section.adoc[]