Bynder Users API

{"openapi":"3.1.0","info":{"title":"Users","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Users","description":"Manage users within your Bynder account. You can create, retrieve, update, and delete users as needed.\n"},{"name":"Users ID","description":"Manage specific users by their ID. This includes retrieving, updating, and deleting user information based on the user ID.\n"},{"name":"Current User","description":"Retrieve information about the currently authenticated user without needing to know their user ID.         \n"}],"paths":{"/api/v4/users/":{"get":{"summary":"Retrieve users","tags":["Users"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"parameters":[{"name":"includeInActive","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"Whether to include inactive users in the list of results."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100},"description":"Maximum results to return. If limit is not provided, all results are returned."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1},"description":"What page of results to return."}],"responses":{"200":{"description":"Successful response","headers":{"X-Pagination-TotalRecords":{"schema":{"type":"integer"},"description":"Total number of records."},"X-Pagination-TotalPages":{"schema":{"type":"integer"},"description":"Total number of pages."},"X-Pagination-Page":{"schema":{"type":"integer"},"description":"Current page number."},"X-Pagination-Limit":{"schema":{"type":"integer"},"description":"Limit of records per page."}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email2":{"type":"string"},"salesrepId":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"active":{"type":"integer"},"isSSOOnly":{"type":"boolean"},"username":{"type":"string"},"email":{"type":"string"},"profileId":{"type":"string"},"employeeNumber":{"type":"string"},"timeZone":{"type":"string"},"website":{"type":"string"},"country":{"type":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}}}}}}}}},"post":{"summary":"Create user","tags":["Users"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"201":{"description":"User created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"}}}}}}}}},"/api/v4/users/{id}":{"get":{"summary":"Retrieve specific user","tags":["Users ID"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The id or username of the user you’d like to retrieve."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string"},"profileId":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"department":{"type":"string"},"job":{"type":"string"},"state":{"type":"string"},"firstname":{"type":"string"},"city":{"type":"string"},"infix":{"type":"string"},"timeZone":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"persisted":{"type":"boolean"},"legalEntity":{"type":"string"},"county":{"type":"string"},"postalCode":{"type":"string"},"language":{"type":"string"},"country":{"type":"string"},"costCenter":{"type":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}},"lastname":{"type":"string"},"cellphoneNumber":{"type":"string"},"employeeNumber":{"type":"string"},"departmentCode":{"type":"string"},"gender":{"type":"string"},"id":{"type":"string"},"companyName":{"type":"string"},"active":{"type":"boolean"},"isSSOOnly":{"type":"boolean"},"address":{"type":"string"},"terms":{"type":"string"}}}}}}}},"post":{"summary":"Modify user","tags":["Users ID"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The id of the user you’d like to modify."}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"profileId":{"type":"string"},"active":{"type":"integer","enum":[1,0],"default":1},"isSSOOnly":{"type":"boolean","default":false},"language":{"type":"string"},"firstname":{"type":"string"},"infix":{"type":"string"},"lastname":{"type":"string"},"groupIds":{"type":"string"},"phoneNumber":{"type":"string"},"companyName":{"type":"string"},"department":{"type":"string"},"job":{"type":"string"},"costCenter":{"type":"string"},"termsAccepted":{"type":"boolean"}}}}}},"responses":{"202":{"description":"User modified","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"}}}}}}}},"delete":{"summary":"Delete user","tags":["Users ID"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The id or username of the user you’d like to delete."}],"responses":{"204":{"description":"User deleted"}}}},"/api/v4/currentUser/":{"get":{"summary":"Retrieve current user","description":"Retrieve the current user information. Unlike [Retrieve specific user](#reference/users/specific-user-operations/retrieve-specific-user) this call doesn't require you to know your user id in order to retrieve your current user information.\n","tags":["Current User"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string"},"profileId":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"department":{"type":"string"},"job":{"type":"string"},"state":{"type":"string"},"firstname":{"type":"string"},"city":{"type":"string"},"infix":{"type":"string"},"timeZone":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"persisted":{"type":"boolean"},"legalEntity":{"type":"string"},"county":{"type":"string"},"postalCode":{"type":"string"},"language":{"type":"string"},"country":{"type":"string"},"costCenter":{"type":"string"},"lastname":{"type":"string"},"cellphoneNumber":{"type":"string"},"employeeNumber":{"type":"string"},"departmentCode":{"type":"string"},"gender":{"type":"string"},"id":{"type":"string"},"companyName":{"type":"string"},"active":{"type":"boolean"},"isSSOOnly":{"type":"boolean"},"address":{"type":"string"},"terms":{"type":"string"}}}}}}}}}},"components":{"schemas":{"User":{"properties":{"username":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"profileId":{"type":"string"},"active":{"type":"integer","enum":[1,0],"default":1},"isSSOOnly":{"type":"boolean","default":false},"language":{"type":"string"},"firstname":{"type":"string"},"infix":{"type":"string"},"lastname":{"type":"string"},"groupIds":{"type":"string"},"phoneNumber":{"type":"string"},"companyName":{"type":"string"},"department":{"type":"string"},"job":{"type":"string"},"costCenter":{"type":"string"}},"required":["password","email","profileId","firstname","lastname"]}},"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}}}}}}}