Organization
bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
name*stringThe name of the organization
1 <= lengthslug*stringThe slug of the organization
1 <= lengthuserId?stringThe user id of the organization creator. If not provided, the current user will be used. Should only be used by admins or when called by the server. server-only. Eg: "user-id"
logo?|The logo of the organization
metadata?The metadata of the organization
keepCurrentActiveOrganization?booleanWhether to keep the current active organization active after creating a new one. Eg: true
updatedAt?string|nullisArchived?boolean|nullarchivedAt?string|nullSuccess
application/json- response
The organization that was created
id*stringname*stringslug*stringlogo?stringcreatedAt*stringdate-timemetadata?stringupdatedAt?stringdate-timeisArchived?booleanarchivedAt?stringdate-timecurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/create' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "slug": "string"}'{ "id": "string", "name": "string", "slug": "string", "logo": "string", "createdAt": "2019-08-24T14:15:22Z", "metadata": "string", "updatedAt": "2019-08-24T14:15:22Z", "isArchived": true, "archivedAt": "2019-08-24T14:15:22Z"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
data*organizationId?stringThe organization ID. Eg: "org-id"
Success
application/json- response
The updated organization
id*stringname*stringslug*stringlogo?stringcreatedAt*stringdate-timemetadata?stringupdatedAt?stringdate-timeisArchived?booleanarchivedAt?stringdate-timecurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/update' \ -H 'Content-Type: application/json' \ -d '{ "data": {}}'{ "id": "string", "name": "string", "slug": "string", "logo": "string", "createdAt": "2019-08-24T14:15:22Z", "metadata": "string", "updatedAt": "2019-08-24T14:15:22Z", "isArchived": true, "archivedAt": "2019-08-24T14:15:22Z"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
organizationId*stringThe organization id to delete
Success
response?stringapplication/jsonThe organization id that was deleted
curl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/delete' \ -H 'Content-Type: application/json' \ -d '{ "organizationId": "string"}'"string"bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
organizationId?|The organization id to set as active. It can be null to unset the active organization. Eg: "org-id"
organizationSlug?stringThe organization slug to set as active. It can be null to unset the active organization if organizationId is not provided. Eg: "org-slug"
Success
application/json- response
The organization
id*stringname*stringslug*stringlogo?stringcreatedAt*stringdate-timemetadata?stringupdatedAt?stringdate-timeisArchived?booleanarchivedAt?stringdate-timecurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/set-active' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "name": "string", "slug": "string", "logo": "string", "createdAt": "2019-08-24T14:15:22Z", "metadata": "string", "updatedAt": "2019-08-24T14:15:22Z", "isArchived": true, "archivedAt": "2019-08-24T14:15:22Z"}bearerAuthAuthorizationBearer <token>Bearer token authentication
Success
application/json- response
The organization
id*stringname*stringslug*stringlogo?stringcreatedAt*stringdate-timemetadata?stringupdatedAt?stringdate-timeisArchived?booleanarchivedAt?stringdate-timecurl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/get-organization'{ "id": "string", "name": "string", "slug": "string", "logo": "string", "createdAt": "2019-08-24T14:15:22Z", "metadata": "string", "updatedAt": "2019-08-24T14:15:22Z", "isArchived": true, "archivedAt": "2019-08-24T14:15:22Z"}bearerAuthAuthorizationBearer <token>Bearer token authentication
Success
application/json- response
The organization
id*stringname*stringslug*stringlogo?stringcreatedAt*stringdate-timemetadata?stringupdatedAt?stringdate-timeisArchived?booleanarchivedAt?stringdate-timecurl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/get-full-organization'{ "id": "string", "name": "string", "slug": "string", "logo": "string", "createdAt": "2019-08-24T14:15:22Z", "metadata": "string", "updatedAt": "2019-08-24T14:15:22Z", "isArchived": true, "archivedAt": "2019-08-24T14:15:22Z"}bearerAuthAuthorizationBearer <token>Bearer token authentication
Success
application/json- response
[index: integer]?curl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/list'[ { "id": "string", "name": "string", "slug": "string", "logo": "string", "createdAt": "2019-08-24T14:15:22Z", "metadata": "string", "updatedAt": "2019-08-24T14:15:22Z", "isArchived": true, "archivedAt": "2019-08-24T14:15:22Z" }]bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
email*stringThe email address of the user to invite
role*|array<>The role(s) to assign to the user. It can be admin, member, owner. Eg: "member"
organizationId?stringThe organization ID to invite the user to
resend?booleanResend the invitation email, if the user is already invited. Eg: true
teamId?|array<string>updatedAt?string|nullstatus*stringsource?string|nulloauthScopes?array<string>|nulloauthRedirectUri?string|nullSuccess
application/json- response
id*stringemail*stringrole*stringorganizationId*stringinviterId*stringstatus*stringexpiresAt*stringcreatedAt*stringcurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/invite-member' \ -H 'Content-Type: application/json' \ -d '{ "email": "string", "role": "string", "status": "string"}'{ "id": "string", "email": "string", "role": "string", "organizationId": "string", "inviterId": "string", "status": "string", "expiresAt": "string", "createdAt": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
invitationId*stringThe ID of the invitation to cancel
Bad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/cancel-invitation' \ -H 'Content-Type: application/json' \ -d '{ "invitationId": "string"}'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
invitationId*stringThe ID of the invitation to accept
Success
application/json- response
invitation?member?curl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/accept-invitation' \ -H 'Content-Type: application/json' \ -d '{ "invitationId": "string"}'{ "invitation": {}, "member": {}}bearerAuthAuthorizationBearer <token>Bearer token authentication
id?stringThe ID of the invitation to get
Success
application/json- response
id*stringemail*stringrole*stringorganizationId*stringinviterId*stringstatus*stringexpiresAt*stringorganizationName*stringorganizationSlug*stringinviterEmail*stringcurl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/get-invitation'{ "id": "string", "email": "string", "role": "string", "organizationId": "string", "inviterId": "string", "status": "string", "expiresAt": "string", "organizationName": "string", "organizationSlug": "string", "inviterEmail": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
invitationId*stringThe ID of the invitation to reject
Success
application/json- response
invitation?member?curl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/reject-invitation' \ -H 'Content-Type: application/json' \ -d '{ "invitationId": "string"}'{ "invitation": {}, "member": {}}bearerAuthAuthorizationBearer <token>Bearer token authentication
Bad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/list-invitations'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
Success
application/json- response
id*stringuserId*stringorganizationId*stringrole*stringcurl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/get-active-member'{ "id": "string", "userId": "string", "organizationId": "string", "role": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
slug*stringThe organization slug to check. Eg: "my-org"
Bad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/check-slug' \ -H 'Content-Type: application/json' \ -d '{ "slug": "string"}'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
memberIdOrEmail*stringThe ID or email of the member to remove
organizationId?stringThe ID of the organization to remove the member from. If not provided, the active organization will be used. Eg: "org-id"
Success
application/json- response
member*curl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/remove-member' \ -H 'Content-Type: application/json' \ -d '{ "memberIdOrEmail": "string"}'{ "member": { "id": "string", "userId": "string", "organizationId": "string", "role": "string" }}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
role*|array<string>The new role to be applied. This can be a string or array of strings representing the roles. Eg: ["admin", "sale"]
memberId*stringThe member id to apply the role update to. Eg: "member-id"
organizationId?stringAn optional organization ID which the member is a part of to apply the role update. If not provided, you must provide session headers to get the active organization. Eg: "organization-id"
Success
application/json- response
member*curl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/update-member-role' \ -H 'Content-Type: application/json' \ -d '{ "role": "string", "memberId": "string"}'{ "member": { "id": "string", "userId": "string", "organizationId": "string", "role": "string" }}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
organizationId*stringThe organization Id for the member to leave. Eg: "organization-id"
Bad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/leave' \ -H 'Content-Type: application/json' \ -d '{ "organizationId": "string"}'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
Success
application/json- response
[index: integer]?curl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/list-user-invitations'[ { "id": "string", "email": "string", "role": "string", "organizationId": "string", "organizationName": "string", "inviterId": "string", "teamId": "string", "status": "string", "expiresAt": "string", "createdAt": "string" }]bearerAuthAuthorizationBearer <token>Bearer token authentication
Bad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/get-active-member-role'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
name*stringThe name of the team. Eg: "my-team"
organizationId?stringThe organization ID which the team will be created in. Defaults to the active organization. Eg: "organization-id"
status*stringTeam created successfully
application/json- response
id*stringUnique identifier of the created team
name*stringName of the team
organizationId*stringID of the organization the team belongs to
createdAt*stringTimestamp when the team was created
date-timeupdatedAt*stringTimestamp when the team was last updated
date-timecurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/create-team' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "status": "string"}'{ "id": "string", "name": "string", "organizationId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
teamId*stringThe team ID of the team to remove. Eg: "team-id"
organizationId?stringThe organization ID which the team falls under. If not provided, it will default to the user's active organization. Eg: "organization-id"
Team removed successfully
application/json- response
message*"Team removed successfully."Confirmation message indicating successful removal
"Team removed successfully."curl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/remove-team' \ -H 'Content-Type: application/json' \ -d '{ "teamId": "string"}'{ "message": "Team removed successfully."}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
teamId*stringThe ID of the team to be updated. Eg: "team-id"
data*Team updated successfully
application/json- response
id*stringUnique identifier of the updated team
name*stringUpdated name of the team
organizationId*stringID of the organization the team belongs to
createdAt*stringTimestamp when the team was created
date-timeupdatedAt*stringTimestamp when the team was last updated
date-timecurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/update-team' \ -H 'Content-Type: application/json' \ -d '{ "teamId": "string", "data": {}}'{ "id": "string", "name": "string", "organizationId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
teamId?|The team id to set as active. It can be null to unset the active team
Success
application/json- response
The team
id*stringname*stringmemberCount?number0organizationId*stringcreatedAt*stringdate-timeupdatedAt?stringdate-timestatus*stringcurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/set-active-team' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "name": "string", "memberCount": 0, "organizationId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "status": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
Teams retrieved successfully
application/json- response
Array of team objects within the organization
[index: integer]?The team
curl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/list-user-teams'[ { "id": "string", "name": "string", "memberCount": 0, "organizationId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "status": "string" }]bearerAuthAuthorizationBearer <token>Bearer token authentication
Teams retrieved successfully
application/json- response
Array of team member objects within the team
[index: integer]?The team member
curl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/list-team-members'[ { "id": "string", "userId": "string", "teamId": "string", "createdAt": "2019-08-24T14:15:22Z" }]bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
teamId*stringThe team the user should be a member of.
userId*stringThe user Id which represents the user to be added as a member.
organizationId?stringThe organization ID which the team falls under. If not provided, it will default to the user's active organization.
Team member created successfully
application/json- response
The team member
id*stringUnique identifier of the team member
userId*stringThe user ID of the team member
teamId*stringThe team ID of the team the team member is in
createdAt*stringTimestamp when the team member was created
date-timecurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/add-team-member' \ -H 'Content-Type: application/json' \ -d '{ "teamId": "string", "userId": "string"}'{ "id": "string", "userId": "string", "teamId": "string", "createdAt": "2019-08-24T14:15:22Z"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
teamId*stringThe team the user should be removed from.
userId*stringThe user which should be removed from the team.
organizationId?stringThe organization ID which the team falls under. If not provided, it will default to the user's active organization.
Team member removed successfully
application/json- response
message*"Team member removed successfully."Confirmation message indicating successful removal
"Team member removed successfully."curl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/remove-team-member' \ -H 'Content-Type: application/json' \ -d '{ "teamId": "string", "userId": "string"}'{ "message": "Team member removed successfully."}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
organizationId?stringrole*stringThe name of the role to create
permission*The permission to assign to the role
additionalFields?Bad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/create-role' \ -H 'Content-Type: application/json' \ -d '{ "role": "string", "permission": { "property1": [ "string" ], "property2": [ "string" ] }}'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
roleName*stringThe name of the role to delete
1 <= lengthorganizationId?stringBad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/delete-role' \ -H 'Content-Type: application/json' \ -d '{ "roleName": "string"}'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
Bad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/list-roles'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
Bad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X GET 'https://dev.auth.graphxserver.io/api/auth/organization/get-role'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
roleName*stringThe name of the role to update
1 <= lengthorganizationId?stringdata*Bad Request. Usually due to missing parameters, or invalid parameters.
application/json- response
message*stringcurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/update-role' \ -H 'Content-Type: application/json' \ -d '{ "data": {}, "roleName": "string"}'{ "message": "string"}bearerAuthAuthorizationBearer <token>Bearer token authentication
application/json- body
permission?DeprecatedThe permission to check
permissions*The permission to check
Success
application/json- response
error?stringsuccess*booleancurl -X POST 'https://dev.auth.graphxserver.io/api/auth/organization/has-permission' \ -H 'Content-Type: application/json' \ -d '{ "permissions": {}}'{ "error": "string", "success": true}